Szkolenie
Moduł
Dowiedz się, jak używać zestawu .NET SDK z usługą Azure OpenAI, aby aplikacje prowadziły rozmowy z użytkownikami w języku naturalnym.
Ta przeglądarka nie jest już obsługiwana.
Przejdź na przeglądarkę Microsoft Edge, aby korzystać z najnowszych funkcji, aktualizacji zabezpieczeń i pomocy technicznej.
Ten artykuł zawiera szczegółowe informacje na temat punktów końcowych interfejsu API REST wnioskowania dla usługi Azure OpenAI.
Zarządzanie modelami i zasobami platformy Azure OpenAI i zarządzanie nimi jest podzielone na trzy podstawowe powierzchnie interfejsu API:
Każda powierzchnia/specyfikacja interfejsu API hermetyzuje inny zestaw funkcji usługi Azure OpenAI. Każdy interfejs API ma swój własny unikatowy zestaw wersji zapoznawczych i stabilne/ogólnie dostępne wersje interfejsu API. Obecnie wersje zapoznawcza mają tendencję do śledzenia miesięcznego tempa.
interfejs 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 udostępnia wspólną płaszczyznę sterowania wszystkim innym usługom Azure AI Services. 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 zarządza również możliwościami, takimi jak azure Resource Manager, Bicep, Terraform i interfejs wiersza polecenia platformy Azure. |
Płaszczyzna danych — tworzenie | 2025-01-01-preview |
2024-10-21 |
Pliki specyfikacji | Interfejs API tworzenia płaszczyzny danych steruje dostrajaniem, przekazywaniem plików, zadaniami pozyskiwania danych, zapytaniami na poziomie usługi Batch i określonymi zapytaniami na poziomie modelu |
Płaszczyzna danych — wnioskowanie | 2025-01-01-preview |
2024-10-21 |
Pliki specyfikacji | Interfejs API wnioskowania płaszczyzny danych zapewnia możliwości wnioskowania/punktów końcowych dla funkcji, takich jak ukończenie, ukończenie czatu, osadzanie, mowę/szepta, na danych, dall-e, asystentów itp. |
Usługa Azure OpenAI udostępnia dwie metody uwierzytelniania. Możesz użyć kluczy interfejsu API lub identyfikatora entra firmy Microsoft.
Uwierzytelnianie klucza interfejsu API: w przypadku tego typu uwierzytelniania wszystkie żądania interfejsu API muszą zawierać klucz interfejsu API w nagłówku api-key
HTTP. Przewodnik Szybki start zawiera wskazówki dotyczące wykonywania wywołań przy użyciu tego typu uwierzytelniania.
Uwierzytelnianie identyfikatora Entra firmy Microsoft: możesz uwierzytelnić wywołanie interfejsu API przy użyciu tokenu Entra firmy Microsoft. Tokeny uwierzytelniania są dołączane do żądania jako nagłówka Authorization
. Podany token musi być poprzedzony elementem Bearer
, na przykład Bearer YOUR_AUTH_TOKEN
. Możesz przeczytać nasz przewodnik z instrukcjami dotyczącymi uwierzytelniania za pomocą identyfikatora Entra firmy Microsoft.
Interfejsy API usługi są wersjonowane przy użyciu parametru api-version
zapytania. Wszystkie wersje są zgodne ze strukturą dat RRRR-MM-DD. Na przykład:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
W pozostałej części artykułu omówiono najnowszą wersję zapoznawczą specyfikacji wnioskowania płaszczyzny danych usługi Azure OpenAI. 2025-01-01-preview
Ten artykuł zawiera dokumentację najnowszych funkcji w wersji zapoznawczej, takich jak asystenci, wątki i magazyny wektorów.
Jeśli szukasz dokumentacji najnowszej wersji interfejsu API ga, zapoznaj się z najnowszym interfejsem API wnioskowania płaszczyzny danych ogólnie dostępnego
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-01-01-preview
Tworzy uzupełnianie dla podanego monitu, parametrów i wybranego modelu.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
deployment-id | path | Tak | string | Identyfikator wdrożenia modelu, który został wdrożony. |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
monit | ciąg lub tablica | Monity dotyczące generowania uzupełniania dla ciągów, tablicy ciągów, tablicy tokenów, tablicy tokenów lub tablicy tablicy tokenów. Należy pamiętać, że <|endoftext|> jest separatorem dokumentu, który widzi model podczas trenowania, więc jeśli monit nie zostanie określony, model zostanie wygenerowany tak, jakby od początku nowego dokumentu. |
Tak | |
best_of | integer | Generuje uzupełnianie best_of po stronie serwera i zwraca wartość "best" (jedyną z najwyższym prawdopodobieństwem dziennika na token). Nie można przesyłać strumieniowo wyników.W przypadku użycia z elementem n best_of określa liczbę ukończonych kandydatów i n określa, ile należy zwrócić â € " best_of musi być większe niż n .Uwaga: ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop . |
Nie. | 1 |
echo | boolean | Powtórz ponownie monit oprócz ukończenia |
Nie. | Fałsz |
frequency_penalty | 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 |
logit_bias | obiekt | Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokenu w tokenizatorze GPT) do skojarzonej wartości od -100 do 100. Matematycznie stronniczy jest dodawany 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. | Brak |
logprobs | integer | Uwzględnij prawdopodobieństwa dziennika dla logprobs najbardziej prawdopodobnych tokenów wyjściowych, a także wybrane tokeny. Na przykład jeśli logprobs ma wartość 5, interfejs API zwróci listę 5 najbardziej prawdopodobnych tokenów. Interfejs API zawsze zwraca logprob przykładowy token, więc może istnieć maksymalnie logprobs+1 elementy w odpowiedzi.Maksymalna wartość parametru logprobs to 5. |
Nie. | Brak |
max_tokens | integer | Maksymalna liczba tokenów, które można wygenerować w zakończeniu. Liczba tokenów monitu plus max_tokens nie może przekraczać długości kontekstu modelu. |
Nie. | 16 |
n | integer | Ile uzupełniania ma być generowanych dla każdego monitu. Uwaga: ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop . |
Nie. | 1 |
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. Działaniezażądaj, aby ten model wygenerował zarówno odpowiedzi tekstowe, jak i dźwiękowe. Użyj programu: ["text", "audio"] |
Nie. | |
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. | |
dźwięk | obiekt | Parametry dla danych wyjściowych dźwięku. Wymagane w przypadku żądania danych wyjściowych dźwięku za pomocą poleceniamodalities: ["audio"] . |
Nie. | |
presence_penalty | Liczba | Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach. |
Nie. | 0 |
nasienie | integer | 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 system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu. |
Nie. | |
zatrzymać | ciąg lub tablica | Maksymalnie cztery sekwencje, w których interfejs API przestanie generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania. |
Nie. | |
strumień | boolean | Czy przesyłać strumieniowo częściowy postęp. W przypadku ustawienia tokeny będą wysyłane jako zdarzenia wysyłane tylko do serwera, gdy staną się dostępne, a strumień zostanie zakończony komunikatemdata: [DONE] . |
Nie. | Fałsz |
przyrostek | string | Sufiks, który pojawia się po zakończeniu wstawionego tekstu. Ten parametr jest obsługiwany tylko dla programu gpt-3.5-turbo-instruct . |
Nie. | Brak |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów. |
Nie. | 1 |
Użytkownik | string | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
voice | string | Określa typ głosu. Obsługiwane głosy to alloy , , echo fable , onyx , nova i shimmer . |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
format | string | Określa format dźwięku wyjściowego. Musi być jednym z wav elementów , , mp3 , flac opus lub pcm16 . |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | createCompletionResponse | Reprezentuje odpowiedź ukończenia z interfejsu API. Uwaga: zarówno przesyłane strumieniowo, jak i nie przesyłane strumieniowo obiekty odpowiedzi mają ten sam kształt (w przeciwieństwie do punktu końcowego czatu). |
Kod stanu: wartość domyślna
Opis: Usługa niedostępna
Typ zawartości | Type | Opis |
---|---|---|
application/json | errorResponse |
Tworzy uzupełnianie dla podanego monitu, parametrów i wybranego modelu.
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-01-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
}
}
}
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-01-01-preview
Uzyskaj wektorową reprezentację danych wejściowych, które mogą być łatwo używane przez modele i algorytmy uczenia maszynowego.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
deployment-id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
input | ciąg lub tablica | Tekst wejściowy do osadzenia, zakodowany jako ciąg lub tablica tokenów. Aby osadzić wiele danych wejściowych w jednym żądaniu, przekaż tablicę ciągów lub tablicę tablic tokenów. Dane wejściowe nie mogą przekraczać maksymalnych tokenów wejściowych dla modelu (8192 tokenów dla text-embedding-ada-002 ), nie mogą być pustymi ciągami, a każda tablica musi mieć 2048 wymiarów lub mniej. |
Tak | |
Użytkownik | string | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć. | Nie. | |
input_type | string | typ danych wejściowych wyszukiwania osadzania do użycia | Nie. | |
encoding_format | string | Format umożliwiający zwrócenie osadzania. Może to być wartość float lub base64 . Wartość domyślna to float . |
Nie. | |
wymiary | integer | Liczba wymiarów, które powinny mieć wynikowe osadzanie danych wyjściowych. Obsługiwane tylko w text-embedding-3 modelach i nowszych. |
Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
model | string | Tak | ||
dane | tablica | Tak | ||
użycie | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
prompt_tokens | integer |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
total_tokens | integer |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | obiekt |
Zwróć osadzanie dla danego monitu.
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-01-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.0040426035,
-0.03443847,
-0.00091273896,
-0.0019217303,
0.002349888,
-0.021560553,
0.016515596,
-0.015572986,
0.0038666942
]
}
],
"usage": {
"prompt_tokens": 4,
"total_tokens": 4
}
}
}
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-01-01-preview
Tworzy ukończenie wiadomości na czacie
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
deployment-id | path | Tak | string | Identyfikator wdrożenia modelu, który został wdrożony. |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów. |
Nie. | 1 |
strumień | boolean | 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 tylko do serwera, gdy staną się dostępne, a strumień zostanie zakończony komunikatemdata: [DONE] . |
Nie. | Fałsz |
zatrzymać | ciąg lub tablica | Maksymalnie cztery sekwencje, w których interfejs API przestanie generować kolejne tokeny. |
Nie. | |
max_tokens | integer | 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. | |
max_completion_tokens | integer | 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. | |
presence_penalty | Liczba | Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach. |
Nie. | 0 |
frequency_penalty | 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 |
logit_bias | obiekt | Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z zakresu od -100 do 100. Matematycznie stronniczy jest dodawany 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. | Brak |
store | boolean | Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu. | Nie. | |
metadane | obiekt | Tagi i wartości zdefiniowane przez dewelopera używane do filtrowania uzupełniania na pulpicie nawigacyjnym przechowywanych uzupełniania. | Nie. | |
Użytkownik | string | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć. |
Nie. | |
wiadomości | tablica | Lista wiadomości składających się z konwersacji do tej pory. | Tak | |
data_sources | tablica | 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. | |
reasoning_effort | wyliczenie |
Tylko modele o1 Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości to low , medium i 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: niski, średni, wysoki |
Nie. | |
logprobs | boolean | Czy zwracać prawdopodobieństwo dziennika tokenów wyjściowych, czy nie. Jeśli wartość true, zwraca prawdopodobieństwo dziennika każdego tokenu wyjściowego zwróconego w elemecie content message . |
Nie. | Fałsz |
top_logprobs | integer | Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji tokenu, z których każde ma skojarzone prawdopodobieństwo dziennika.
logprobs musi być ustawiona na true wartość , jeśli ten parametr jest używany. |
Nie. | |
n | integer | Ile opcji ukończenia czatu ma być generowanych dla każdej wiadomości wejściowej. Pamiętaj, że opłaty będą naliczane na podstawie liczby wygenerowanych tokenów we wszystkich opcjach. Zachowaj n , 1 aby zminimalizować koszty. |
Nie. | 1 |
parallel_tool_calls | ParallelToolCalls | Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia. | Nie. | Prawda |
response_format | ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema | Obiekt określający format, który musi zostać wygenerowany przez model. Zgodność z GPT-4o, GPT-4o mini, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo nowszymi niż gpt-3.5-turbo-1106 . Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, które gwarantuje, że model będzie zgodny z podanym schematem JSON.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. | |
nasienie | integer | 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 system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu. |
Nie. | |
stream_options | chatCompletionStreamOptions | Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true |
Nie. | Brak |
tools | tablica | Lista narzędzi, które może wywołać model. Obecnie tylko funkcje są obsługiwane jako narzędzie. Służy do udostępniania listy funkcji, dla których model może generować dane wejściowe JSON. Obsługiwane są maksymalnie 128 funkcji. |
Nie. | |
tool_choice | chatCompletionToolChoiceOption | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.
none oznacza, że model nie wywoła żadnego narzędzia, a zamiast tego generuje komunikat.
auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia.
required oznacza, że model musi wywoływać co najmniej jedno narzędzie. Określenie określonego narzędzia za pośrednictwem {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.
none jest ustawieniem domyślnym, gdy żadne narzędzia nie są obecne.
auto jest wartością domyślną, jeśli istnieją narzędzia. |
Nie. | |
function_call | ciąg lub czatCompletionFunctionCallOption | Przestarzałe na rzecz .tool_choice Określa, która (jeśli istnieje) funkcja jest wywoływana przez model. none oznacza, że model nie wywoła funkcji, a zamiast tego generuje komunikat.auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem funkcji.Określenie określonej funkcji za pośrednictwem {"name": "my_function"} wymusza wywołanie tej funkcji przez model.none jest wartością domyślną, gdy nie ma żadnych funkcji.
auto jest wartością domyślną, jeśli funkcje są obecne. |
Nie. | |
— funkcje | tablica | Przestarzałe na rzecz .tools Lista funkcji, dla których model może generować dane wejściowe JSON. |
Nie. | |
user_security_context | userSecurityContext | Kontekst zabezpieczeń użytkownika zawiera kilka parametrów opisujących samą aplikację sztucznej inteligencji oraz użytkownika końcowego, który wchodzi w interakcję z aplikacją sztucznej inteligencji. Te pola ułatwiają zespołom ds. operacji zabezpieczeń badanie i eliminowanie zdarzeń zabezpieczeń, zapewniając kompleksowe podejście do ochrony aplikacji sztucznej inteligencji. Dowiedz się więcej o ochronie aplikacji sztucznej inteligencji przy użyciu Microsoft Defender dla Chmury. | Nie. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | createChatCompletionResponse lub createChatCompletionStreamResponse |
Kod stanu: wartość domyślna
Opis: Usługa niedostępna
Typ zawartości | Type | Opis |
---|---|---|
application/json | errorResponse |
Tworzy uzupełnianie dla podanego monitu, parametrów i wybranego modelu.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-01-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
}
}
}
Tworzy uzupełnianie na podstawie danych usługi Azure Search i przypisanej przez system tożsamości zarządzanej.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-01-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
}
}
}
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-01-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
}
}
}
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-01-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
}
}
}
Tworzy ukończenie dla podanej usługi Azure Cosmos DB.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-01-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
}
}
}
Tworzy ukończenie dla podanej bazy danych Mongo DB.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-01-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
}
}
}
Tworzy ukończenie dla podanego programu Elasticsearch.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-01-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
}
}
}
Tworzy ukończenie dla podanego zasobu Pinecone.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-01-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
}
}
}
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-01-01-preview
Transkrybuje dźwięk w języku wejściowym.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
deployment-id | path | Tak | string | Identyfikator wdrożenia modelu szeptu. |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: multipart/form-data
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
plik | string | Obiekt pliku audio do transkrypcji. | Tak | |
monit | string | Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być zgodny z językiem dźwięku. | Nie. | |
response_format | audioResponseFormat | Definiuje format danych wyjściowych. | Nie. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model użyje prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu trafienia określonych progów. | Nie. | 0 |
język | string | Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 poprawi dokładność i opóźnienie. | Nie. | |
timestamp_granularities[] | tablica | Stopień szczegółowości sygnatury czasowej do wypełnienia dla tej transkrypcji.
response_format należy ustawić, verbose_json aby używać szczegółowości sygnatury czasowej. Obsługiwane są obie te opcje: word , lub segment . Uwaga: nie ma dodatkowego opóźnienia dla sygnatur czasowych segmentu, ale generowanie znaczników czasu wyrazów powoduje dodatkowe opóźnienie. |
Nie. | ['segment'] |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | audioResponse lub audioVerboseResponse | |
text/plain | string | Transkrypcja tekstu w formacie wyjściowym (gdy response_format był jednym z tekstu, vtt lub srt). |
Pobiera transkrypcja tekstu i skojarzonych metadanych z dostarczonych danych dźwiękowych mówionych.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Pobiera transkrypcja tekstu i skojarzonych metadanych z dostarczonych danych dźwiękowych mówionych.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-01-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"
}
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-01-01-preview
Transkrybuje i tłumaczy dźwięk wejściowy na tekst w języku angielskim.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
deployment-id | path | Tak | string | Identyfikator wdrożenia modelu szeptu, który został wdrożony. |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: multipart/form-data
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
plik | string | Plik audio do tłumaczenia. | Tak | |
monit | string | Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być w języku angielskim. | Nie. | |
response_format | audioResponseFormat | Definiuje format danych wyjściowych. | Nie. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model użyje prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu trafienia określonych progów. | Nie. | 0 |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | audioResponse lub audioVerboseResponse | |
text/plain | string | Transkrypcja tekstu w formacie wyjściowym (gdy response_format był jednym z tekstu, vtt lub srt). |
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-01-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"
}
}
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-01-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"
}
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-01-01-preview
Generuje dźwięk z tekstu wejściowego.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
deployment-id | path | Tak | string | Identyfikator wdrożenia modelu tts, który został wdrożony. |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: multipart/form-data
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
dane_wejściowe | string | Tekst do syntezowania dźwięku. Maksymalna długość to 4096 znaków. | Tak | |
voice | wyliczenie | Głos używany do syntezy mowy. Możliwe wartości: stop, echo, fable, onyx, nova, shimmer |
Tak | |
response_format | wyliczenie | Format syntetyzowania dźwięku. Możliwe wartości: mp3, opus, aac, flac, wav, pcm |
Nie. | |
szybkość | Liczba | Szybkość syntetyzowanego dźwięku. Wybierz wartość z 0.25 do 4.0 . Wartość domyślna to 1.0 . |
Nie. | 1.0 |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/octet-stream | string |
Syntetyzuje dźwięk z dostarczonego tekstu.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-01-01-preview
{
"input": "Hi! What are you going to make?",
"voice": "fable",
"response_format": "mp3"
}
Odpowiedzi: Kod stanu: 200
{
"body": "101010101"
}
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-01-01-preview
Generuje partię obrazów na podstawie podpisu tekstowego dla danego wdrożenia modelu DALLE
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
deployment-id | path | Tak | string | Identyfikator wdrożenia modelu dalle, który został wdrożony. |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
monit | string | Opis tekstu żądanych obrazów. Maksymalna długość to 4000 znaków. | Tak | |
n | integer | Liczba obrazów do wygenerowania. | Nie. | 1 |
size | imageSize | Rozmiar wygenerowanych obrazów. | Nie. | 1024x1024 |
response_format | imagesResponseFormat | Format, w którym są zwracane wygenerowane obrazy. | Nie. | Adres URL |
Użytkownik | string | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć. | Nie. | |
jakość | imageQuality | Jakość obrazu, który zostanie wygenerowany. | Nie. | standardowa |
— styl | imageStyle | Styl wygenerowanych obrazów. | Nie. | żywy |
Kod stanu: 200
Opis: Ok
Typ zawartości | Type | Opis |
---|---|---|
application/json | generateImagesResponse |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
Typ zawartości | Type | Opis |
---|---|---|
application/json | dalleErrorResponse |
Tworzy obrazy z monitem.
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-01-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
}
}
}
]
}
}
GET https://{endpoint}/openai/assistants?api-version=2025-01-01-preview
Zwraca listę asystentów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
limit | zapytanie | Nie. | integer | |
order | zapytanie | Nie. | string | |
po | zapytanie | Nie. | string | |
przed | zapytanie | Nie. | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | listAssistantsResponse |
Zwraca listę asystentów.
GET https://{endpoint}/openai/assistants?api-version=2025-01-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
}
}
POST https://{endpoint}/openai/assistants?api-version=2025-01-01-preview
Utwórz asystenta przy użyciu modelu i instrukcji.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
model | Tak | |||
nazwa | string | Nazwa asystenta. Maksymalna długość to 256 znaków. |
Nie. | |
opis | string | Opis asystenta. Maksymalna długość to 512 znaków. |
Nie. | |
instrukcje | string | Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków. |
Nie. | |
tools | tablica | Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter , retrieval lub function . |
Nie. | [] |
tool_resources | obiekt | Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
|
vector_stores | tablica | Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | assistantObject | Reprezentuje element assistant , który może wywoływać model i używać narzędzi. |
Utwórz asystenta przy użyciu modelu i instrukcji.
POST https://{endpoint}/openai/assistants?api-version=2025-01-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"
}
}
GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-01-01-preview
Pobiera asystenta.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
assistant_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | assistantObject | Reprezentuje element assistant , który może wywoływać model i używać narzędzi. |
Pobiera asystenta.
GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-01-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"
}
}
POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-01-01-preview
Modyfikuje asystenta.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
assistant_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
model | Nie. | |||
nazwa | string | Nazwa asystenta. Maksymalna długość to 256 znaków. |
Nie. | |
opis | string | Opis asystenta. Maksymalna długość to 512 znaków. |
Nie. | |
instrukcje | string | Instrukcje systemowe używane przez asystenta. Maksymalna długość to 32 768 znaków. |
Nie. | |
tools | tablica | Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter , retrieval lub function . |
Nie. | [] |
tool_resources | obiekt | Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Zastępuje listę identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Zastępuje magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | assistantObject | Reprezentuje element assistant , który może wywoływać model i używać narzędzi. |
Modyfikuje asystenta.
POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-01-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"
}
}
DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-01-01-preview
Usuń asystenta.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
assistant_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | deleteAssistantResponse |
Usuwa asystenta.
DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
"object": "assistant.deleted",
"deleted": true
}
}
POST https://{endpoint}/openai/threads?api-version=2025-01-01-preview
Utwórz wątek.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
wiadomości | tablica | Lista komunikatów do uruchomienia wątku. | Nie. | |
tool_resources | obiekt | Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Magazyn wektorów dołączony do tego wątku. Do wątku może być dołączony maksymalnie jeden magazyn wektorów. |
|
vector_stores | tablica | Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego wątku. Do wątku może być dołączony maksymalnie jeden magazyn wektorów. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | threadObject | Reprezentuje wątek zawierający komunikaty. |
Tworzy wątek.
POST https://{endpoint}/openai/threads?api-version=2025-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread",
"created_at": 1707297136,
"metadata": {}
}
}
GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-01-01-preview
Pobiera wątek.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | threadObject | Reprezentuje wątek zawierający komunikaty. |
Pobiera wątek.
GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread",
"created_at": 1707297136,
"metadata": {},
"tool_resources": {
"code_interpreter": {
"file_ids": []
}
}
}
}
POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-01-01-preview
Modyfikuje wątek.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
tool_resources | obiekt | Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Magazyn wektorów dołączony do tego wątku. Do wątku może być dołączony maksymalnie jeden magazyn wektorów. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | threadObject | Reprezentuje wątek zawierający komunikaty. |
Modyfikuje wątek.
POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-01-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": {}
}
}
DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-01-01-preview
Usuń wątek.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | deleteThreadResponse |
Usuwa wątek.
DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread.deleted",
"deleted": true
}
}
GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-01-01-preview
Zwraca listę komunikatów dla danego wątku.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
limit | zapytanie | Nie. | integer | |
order | zapytanie | Nie. | string | |
po | zapytanie | Nie. | string | |
przed | zapytanie | Nie. | string | |
run_id | zapytanie | Nie. | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | listMessagesResponse |
Wyświetlanie listy komunikatów
GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-01-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
}
}
POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-01-01-preview
Utwórz wiadomość.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
role | string | 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 | |
content | string | Zawartość wiadomości. | Tak | |
Załączniki | tablica | Lista plików dołączonych do wiadomości oraz narzędzia, do których należy je dodać. | 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. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | messageObject | Reprezentuje komunikat w wątku. |
Utwórz wiadomość.
POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-01-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": {}
}
}
GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-01-01-preview
Pobieranie komunikatu.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
message_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | messageObject | Reprezentuje komunikat w wątku. |
Pobieranie komunikatu.
GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-01-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": {}
}
}
POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-01-01-preview
Modyfikuje komunikat.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
message_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | 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. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | messageObject | Reprezentuje komunikat w wątku. |
Zmodyfikuj komunikat.
POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-01-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"
}
}
}
POST https://{endpoint}/openai/threads/runs?api-version=2025-01-01-preview
Utwórz wątek i uruchom go w jednym żądaniu.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
assistant_id | string | Identyfikator asystenta do wykonania tego przebiegu. | Tak | |
wątek | createThreadRequest | Nie. | ||
model | string | 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. | |
instrukcje | string | Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów. | Nie. | |
tools | tablica | 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. | |
tool_resources | obiekt | Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
strumień | boolean | Jeśli true program zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] . |
Nie. | |
stream_options | chatCompletionStreamOptions | Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true |
Nie. | Brak |
max_prompt_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
max_completion_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
truncation_strategy | obcięcie obiektuObject | Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu. | Nie. | |
tool_choice | assistantsApiToolChoiceOption | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.none oznacza, że model nie wywołuje żadnych narzędzi, a zamiast tego generuje komunikat.auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia.Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. |
Nie. | |
parallel_tool_calls | ParallelToolCalls | Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia. | Nie. | Prawda |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Identyfikator magazynu wektorów dołączony do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | runObject | Reprezentuje przebieg wykonywania w wątku. |
Utwórz wątek i uruchom go w jednym żądaniu.
POST https://{endpoint}/openai/threads/runs?api-version=2025-01-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"
}
}
GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-01-01-preview
Zwraca listę przebiegów należących do wątku.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
limit | zapytanie | Nie. | integer | |
order | zapytanie | Nie. | string | |
po | zapytanie | Nie. | string | |
przed | zapytanie | Nie. | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | listRunsResponse |
Zwraca listę przebiegów należących do wątku.
GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-01-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
}
}
POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-01-01-preview
Utwórz przebieg.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
include[] | zapytanie | Nie. | tablica | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
assistant_id | string | Identyfikator asystenta do wykonania tego przebiegu. | Tak | |
model | string | 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. | |
instrukcje | string | Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów. | Nie. | |
additional_instructions | string | 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. | |
additional_messages | tablica | Dodaje dodatkowe komunikaty do wątku przed utworzeniem przebiegu. | Nie. | |
tools | tablica | 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. | |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
strumień | boolean | Jeśli true program zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] . |
Nie. | |
max_prompt_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
max_completion_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
truncation_strategy | obcięcie obiektuObject | Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu. | Nie. | |
tool_choice | assistantsApiToolChoiceOption | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.none oznacza, że model nie wywołuje żadnych narzędzi, a zamiast tego generuje komunikat.auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia.Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. |
Nie. | |
parallel_tool_calls | ParallelToolCalls | Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia. | Nie. | Prawda |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | runObject | Reprezentuje przebieg wykonywania w wątku. |
Utwórz przebieg.
POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-01-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"
}
}
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-01-01-preview
Pobiera przebieg.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
run_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | runObject | Reprezentuje przebieg wykonywania w wątku. |
Pobiera przebieg.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-01-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": {}
}
}
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-01-01-preview
Modyfikuje przebieg.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
run_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | 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. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | runObject | Reprezentuje przebieg wykonywania w wątku. |
Modyfikuje przebieg.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-01-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"
}
}
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-01-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.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
run_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
tool_outputs | tablica | Lista narzędzi, dla których są przesyłane dane wyjściowe. | Tak | |
strumień | boolean | Jeśli true program zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] . |
Nie. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | runObject | Reprezentuje przebieg wykonywania w wątku. |
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-01-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"
}
}
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-01-01-preview
Anuluje przebieg, który ma wartość in_progress
.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
run_id | path | Tak | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | runObject | Reprezentuje przebieg wykonywania w wątku. |
Anuluje przebieg, który ma wartość in_progress
.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-01-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"
}
}
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-01-01-preview
Zwraca listę kroków uruchamiania należących do przebiegu.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
run_id | path | Tak | string | |
limit | zapytanie | Nie. | integer | |
order | zapytanie | Nie. | string | |
po | zapytanie | Nie. | string | |
przed | zapytanie | Nie. | string | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
include[] | zapytanie | Nie. | tablica |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | listRunStepsResponse |
Zwraca listę kroków uruchamiania należących do przebiegu.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-01-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
}
}
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-01-01-preview
Pobiera krok uruchomienia.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
thread_id | path | Tak | string | |
run_id | path | Tak | string | |
step_id | path | Tak | string | |
include[] | zapytanie | Nie. | tablica | |
api-version | zapytanie | Tak | string | Wersja interfejsu API |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | runStepObject | Reprezentuje krok wykonywania przebiegu. |
Pobiera krok uruchomienia.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-01-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
}
}
}
GET https://{endpoint}/openai/vector_stores?api-version=2025-01-01-preview
Zwraca listę magazynów wektorów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
limit | zapytanie | Nie. | integer | |
order | zapytanie | Nie. | string | |
po | zapytanie | Nie. | string | |
przed | zapytanie | Nie. | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | listVectorStoresResponse |
Zwraca listę magazynów wektorów.
GET https://{endpoint}/openai/vector_stores?api-version=2025-01-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
}
}
POST https://{endpoint}/openai/vector_stores?api-version=2025-01-01-preview
Utwórz magazyn wektorów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
file_ids | tablica | 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. | |
nazwa | string | Nazwa magazynu wektorów. | Nie. | |
expires_after | vectorStoreExpirationAfter | Zasady wygasania magazynu wektorów. | Nie. | |
chunking_strategy | autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam | Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. Dotyczy tylko wtedy, gdy file_ids nie ma żadnychmpty. |
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. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreObject | Magazyn wektorów to kolekcja przetworzonych plików może być używana przez file_search narzędzie. |
Tworzy magazyn wektorów.
POST https://{endpoint}/openai/vector_stores?api-version=2025-01-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
}
}
}
GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-01-01-preview
Pobiera magazyn wektorów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreObject | Magazyn wektorów to kolekcja przetworzonych plików może być używana przez file_search narzędzie. |
Pobiera magazyn wektorów.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"id": "vs_abc123",
"object": "vector_store",
"created_at": 1699061776
}
}
POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-01-01-preview
Modyfikuje magazyn wektorów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
nazwa | string | Nazwa magazynu wektorów. | Nie. | |
expires_after | 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. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreObject | Magazyn wektorów to kolekcja przetworzonych plików może być używana przez file_search narzędzie. |
Modyfikuje magazyn wektorów.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-01-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
}
}
}
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-01-01-preview
Usuń magazyn wektorów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | deleteVectorStoreResponse |
Usuwa magazyn wektorów.
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"id": "vs_abc123",
"object": "vector_store.deleted",
"deleted": true
}
}
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-01-01-preview
Zwraca listę plików magazynu wektorowego.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
limit | zapytanie | Nie. | integer | |
order | zapytanie | Nie. | string | |
po | zapytanie | Nie. | string | |
przed | zapytanie | Nie. | string | |
filtr | zapytanie | Nie. | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | listVectorStoreFilesResponse |
Zwraca listę plików magazynu wektorowego.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-01-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
}
}
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-01-01-preview
Utwórz plik magazynu wektorów, dołączając plik do magazynu wektorów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
file_id | string | 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 | |
chunking_strategy | fragmentingStrategyRequestParam | Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. |
Nie. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreFileObject | Lista plików dołączonych do magazynu wektorów. |
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-01-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 https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-01-01-preview
Pobiera plik magazynu wektorów.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
file_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreFileObject | Lista plików dołączonych do magazynu wektorów. |
Pobiera plik magazynu wektorów.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-01-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
}
}
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-01-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.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
file_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | deleteVectorStoreFileResponse |
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-01-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"id": "file_abc123",
"object": "vector_store.file.deleted",
"deleted": true
}
}
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-01-01-preview
Utwórz wektorową partię plików magazynu.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Typ zawartości: application/json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
file_ids | tablica | 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 | |
chunking_strategy | fragmentingStrategyRequestParam | Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. |
Nie. |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreFileBatchObject | Partia plików dołączonych do magazynu wektorów. |
Utwórz wektorową partię plików magazynu.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-01-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 https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-01-01-preview
Pobiera wektorową partię plików magazynu.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
batch_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreFileBatchObject | Partia plików dołączonych do magazynu wektorów. |
Pobiera wektorową partię plików magazynu.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-01-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
}
}
}
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-01-01-preview
Anuluj partię plików magazynu wektorów. Spowoduje to jak najszybsze anulowanie przetwarzania plików w tej partii.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
batch_id | path | Tak | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | vectorStoreFileBatchObject | Partia plików dołączonych do magazynu wektorów. |
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-01-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
}
}
}
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-01-01-preview
Zwraca listę plików magazynu wektorów w partii.
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
endpoint | path | Tak | string Adres URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com . Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com |
vector_store_id | path | Tak | string | |
batch_id | path | Tak | string | |
limit | zapytanie | Nie. | integer | |
order | zapytanie | Nie. | string | |
po | zapytanie | Nie. | string | |
przed | zapytanie | Nie. | string | |
filtr | zapytanie | Nie. | string | |
api-version | zapytanie | Tak | string |
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
api-key | Prawda | string | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Kod stanu: 200
Opis: OK
Typ zawartości | Type | Opis |
---|---|---|
application/json | listVectorStoreFilesResponse |
Zwraca listę plików magazynu wektorowego.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-01-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
}
}
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
error | błąd | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
code | string | Nie | ||
wiadomość | string | Nie |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Param | string | Nie | ||
type | string | Nie | ||
inner_error | innerError | Wewnętrzny błąd z dodatkowymi szczegółami. | Nie. |
Wewnętrzny błąd z dodatkowymi szczegółami.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
code | innerErrorCode | Kody błędów dla obiektu błędu wewnętrznego. | Nie. | |
content_filter_results | contentFilterPromptResults | Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator. | Nie. |
Kody błędów dla obiektu błędu wewnętrznego.
Opis: Kody błędów dla wewnętrznego obiektu błędu.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: InnerErrorCode
Wartości wyliczenia:
Wartość | Opis |
---|---|
ResponsibleAIPolicyViolation | Monit naruszył jedną z więcej reguł filtrowania zawartości. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
error | dalleError | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Param | string | Nie | ||
type | string | Nie | ||
inner_error | dalleInnerError | Wewnętrzny błąd z dodatkowymi szczegółami. | Nie. |
Wewnętrzny błąd z dodatkowymi szczegółami.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
code | innerErrorCode | Kody błędów dla obiektu błędu wewnętrznego. | Nie. | |
content_filter_results | dalleFilterResults | Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator. | Nie. | |
revised_prompt | string | Monit, który został użyty do wygenerowania obrazu, jeśli wystąpiła jakakolwiek poprawka do monitu. | Nie. |
Opisuje zakres w wygenerowanym tekście uzupełniania. Przesunięcie 0 jest pierwszym punktem kodu UTF32 tekstu ukończenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
completion_start_offset | integer | Przesunięcie punktu kodu UTF32, który rozpoczyna zakres. | Tak | |
completion_end_offset | integer | Przesunięcie pierwszego punktu kodu UTF32, który jest wykluczony z zakresu. To pole jest zawsze równe completion_start_offset dla pustych zakresów. To pole jest zawsze większe niż completion_start_offset dla brakowych zakresów. | Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Filtrowane | boolean | Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Filtrowane | boolean | Tak | ||
ważność | string | Nie |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Filtrowane | boolean | Tak | ||
Wykryte | boolean | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
cytat | obiekt | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
URL | string |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
license (licencja) | string |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
szczegóły | tablica | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Filtrowane | boolean | Tak | ||
identyfikator | string | Nie |
Informacje o wynikach filtrowania zawartości.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
seksualny | contentFilterSeverityResult | Nie. | ||
przemoc | contentFilterSeverityResult | Nie. | ||
nienawiść | contentFilterSeverityResult | Nie. | ||
self_harm | contentFilterSeverityResult | Nie. | ||
przekleństwo | contentFilterDetectedResult | Nie. | ||
custom_blocklists | contentFilterDetailedResults | Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów. | Nie. | |
error | errorBase | Nie. |
Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
seksualny | contentFilterSeverityResult | Nie. | ||
przemoc | contentFilterSeverityResult | Nie. | ||
nienawiść | contentFilterSeverityResult | Nie. | ||
self_harm | contentFilterSeverityResult | Nie. | ||
przekleństwo | contentFilterDetectedResult | Nie. | ||
custom_blocklists | contentFilterDetailedResults | Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów. | Nie. | |
error | errorBase | Nie. | ||
Jailbreak | contentFilterDetectedResult | Nie. | ||
indirect_attack | contentFilterDetectedResult | Nie. |
Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o tekście i wulgaryzmach innych firm, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
seksualny | contentFilterSeverityResult | Nie. | ||
przemoc | contentFilterSeverityResult | Nie. | ||
nienawiść | contentFilterSeverityResult | Nie. | ||
self_harm | contentFilterSeverityResult | Nie. | ||
przekleństwo | contentFilterDetectedResult | Nie. | ||
custom_blocklists | contentFilterDetailedResults | Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów. | Nie. | |
error | errorBase | Nie. | ||
protected_material_text | contentFilterDetectedResult | Nie. | ||
protected_material_code | contentFilterDetectedWithCitationResult | Nie. | ||
ungrounded_material | contentFilterDetectedWithCompletionTextSpansResult | Nie. |
Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Filtrowane | boolean | Tak | ||
szczegóły | tablica | Nie. |
Wyniki filtrowania zawartości dla pojedynczego monitu w żądaniu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
prompt_index | integer | Nie. | ||
content_filter_results | contentFilterPromptResults | Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator. | Nie. |
Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych monitów mogą pojawiać się w różnych porach lub w różnych zamówieniach.
Brak zdefiniowanych właściwości dla tego składnika.
Informacje o wynikach filtrowania zawartości.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
seksualny | contentFilterSeverityResult | Nie. | ||
przemoc | contentFilterSeverityResult | Nie. | ||
nienawiść | contentFilterSeverityResult | Nie. | ||
self_harm | contentFilterSeverityResult | Nie. |
Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
seksualny | contentFilterSeverityResult | Nie. | ||
przemoc | contentFilterSeverityResult | Nie. | ||
nienawiść | contentFilterSeverityResult | Nie. | ||
self_harm | contentFilterSeverityResult | Nie. | ||
przekleństwo | contentFilterDetectedResult | Nie. | ||
Jailbreak | contentFilterDetectedResult | Nie. | ||
custom_blocklists | contentFilterDetailedResults | Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów. |
Nie. | 1 |
strumień | boolean | 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 tylko do serwera, gdy staną się dostępne, a strumień zostanie zakończony komunikatem data: [DONE] . |
Nie. | Fałsz |
zatrzymać | ciąg lub tablica | Maksymalnie cztery sekwencje, w których interfejs API przestanie generować kolejne tokeny. | Nie. | |
max_tokens | integer | Maksymalna liczba tokenów dozwolonych dla wygenerowanej odpowiedzi. Domyślnie liczba tokenów, które może zwrócić model, to (4096 — tokeny monitu). Nie jest to zgodne z modelami serii o1. | Nie. | 4,096 |
max_completion_tokens | integer | 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. | |
presence_penalty | Liczba | Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach. | Nie. | 0 |
frequency_penalty | 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 |
logit_bias | obiekt | Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z -100 do 100. Matematycznie stronniczy jest dodawany do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt 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. | |
store | boolean | Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu. | Nie. | |
metadane | obiekt | Tagi i wartości zdefiniowane przez dewelopera używane do filtrowania uzupełniania na pulpicie nawigacyjnym przechowywanych uzupełniania. | Nie. | |
Użytkownik | string | 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. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
monit | ciąg lub tablica | Monity dotyczące generowania uzupełniania dla ciągów, tablicy ciągów, tablicy tokenów, tablicy tokenów lub tablicy tablicy tokenów. Należy pamiętać, że <|endoftext|> jest separatorem dokumentu, który widzi model podczas trenowania, więc jeśli monit nie zostanie określony, model zostanie wygenerowany tak, jakby od początku nowego dokumentu. |
Tak | |
best_of | integer | Generuje uzupełnianie best_of po stronie serwera i zwraca wartość "best" (jedyną z najwyższym prawdopodobieństwem dziennika na token). Nie można przesyłać strumieniowo wyników.W przypadku użycia z elementem n best_of określa liczbę ukończonych kandydatów i n określa, ile należy zwrócić â € " best_of musi być większe niż n .Uwaga: ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop . |
Nie. | 1 |
echo | boolean | Powtórz ponownie monit oprócz ukończenia |
Nie. | Fałsz |
frequency_penalty | 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 |
logit_bias | obiekt | Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokenu w tokenizatorze GPT) do skojarzonej wartości od -100 do 100. Matematycznie stronniczy jest dodawany 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. | Brak |
logprobs | integer | Uwzględnij prawdopodobieństwa dziennika dla logprobs najbardziej prawdopodobnych tokenów wyjściowych, a także wybrane tokeny. Na przykład jeśli logprobs ma wartość 5, interfejs API zwróci listę 5 najbardziej prawdopodobnych tokenów. Interfejs API zawsze zwraca logprob przykładowy token, więc może istnieć maksymalnie logprobs+1 elementy w odpowiedzi.Maksymalna wartość parametru logprobs to 5. |
Nie. | Brak |
max_tokens | integer | Maksymalna liczba tokenów, które można wygenerować w zakończeniu. Liczba tokenów monitu plus max_tokens nie może przekraczać długości kontekstu modelu. |
Nie. | 16 |
n | integer | Ile uzupełniania ma być generowanych dla każdego monitu. Uwaga: ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop . |
Nie. | 1 |
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. Działaniezażądaj, aby ten model wygenerował zarówno odpowiedzi tekstowe, jak i dźwiękowe. Użyj programu: ["text", "audio"] |
Nie. | |
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. | |
dźwięk | obiekt | Parametry dla danych wyjściowych dźwięku. Wymagane w przypadku żądania danych wyjściowych dźwięku za pomocą poleceniamodalities: ["audio"] . |
Nie. | |
presence_penalty | Liczba | Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach. |
Nie. | 0 |
nasienie | integer | 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 system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu. |
Nie. | |
zatrzymać | ciąg lub tablica | Maksymalnie cztery sekwencje, w których interfejs API przestanie generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania. |
Nie. | |
strumień | boolean | Czy przesyłać strumieniowo częściowy postęp. W przypadku ustawienia tokeny będą wysyłane jako zdarzenia wysyłane tylko do serwera, gdy staną się dostępne, a strumień zostanie zakończony komunikatemdata: [DONE] . |
Nie. | Fałsz |
przyrostek | string | Sufiks, który pojawia się po zakończeniu wstawionego tekstu. Ten parametr jest obsługiwany tylko dla programu gpt-3.5-turbo-instruct . |
Nie. | Brak |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów. |
Nie. | 1 |
Użytkownik | string | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
voice | string | Określa typ głosu. Obsługiwane głosy to alloy , , echo fable , onyx , nova i shimmer . |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
format | string | Określa format dźwięku wyjściowego. Musi być jednym z wav elementów , , mp3 , flac opus lub pcm16 . |
Reprezentuje odpowiedź ukończenia z interfejsu API. Uwaga: zarówno przesyłane strumieniowo, jak i nie przesyłane strumieniowo obiekty odpowiedzi mają ten sam kształt (w przeciwieństwie do punktu końcowego czatu).
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Unikatowy identyfikator ukończenia. | Tak | |
Wyborów | tablica | Lista opcji uzupełniania dla modelu wygenerowanego dla monitu wejściowego. | Tak | |
utworzone | integer | Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia ukończenia. | Tak | |
model | string | Model używany do ukończenia. | Tak | |
prompt_filter_results | promptFilterResults | Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych monitów mogą pojawiać się w różnych porach lub w różnych zamówieniach. | Nie. | |
system_fingerprint | string | Ten odcisk palca reprezentuje konfigurację zaplecza, z którą działa model. Można użyć w połączeniu z parametrem seed żądania, aby zrozumieć, kiedy wprowadzono zmiany zaplecza, które mogą mieć wpływ na determinizm. |
Nie. | |
obiekt | wyliczenie | Typ obiektu, który jest zawsze "text_completion" Możliwe wartości: text_completion |
Tak | |
użycie | completionUsage | Statystyki użycia dla żądania ukończenia. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów. |
Nie. | 1 |
strumień | boolean | 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 tylko do serwera, gdy staną się dostępne, a strumień zostanie zakończony komunikatemdata: [DONE] . |
Nie. | Fałsz |
zatrzymać | ciąg lub tablica | Maksymalnie cztery sekwencje, w których interfejs API przestanie generować kolejne tokeny. |
Nie. | |
max_tokens | integer | 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. | |
max_completion_tokens | integer | 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. | |
presence_penalty | Liczba | Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach. |
Nie. | 0 |
frequency_penalty | 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 |
logit_bias | obiekt | Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z zakresu od -100 do 100. Matematycznie stronniczy jest dodawany 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. | Brak |
store | boolean | Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu. | Nie. | |
metadane | obiekt | Tagi i wartości zdefiniowane przez dewelopera używane do filtrowania uzupełniania na pulpicie nawigacyjnym przechowywanych uzupełniania. | Nie. | |
Użytkownik | string | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć. |
Nie. | |
wiadomości | tablica | Lista wiadomości składających się z konwersacji do tej pory. | Tak | |
data_sources | tablica | 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. | |
reasoning_effort | wyliczenie |
Tylko modele o1 Ograniczanie wysiłku w zakresie rozumowania modele rozumowania. Obecnie obsługiwane wartości to low , medium i 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: niski, średni, wysoki |
Nie. | |
logprobs | boolean | Czy zwracać prawdopodobieństwo dziennika tokenów wyjściowych, czy nie. Jeśli wartość true, zwraca prawdopodobieństwo dziennika każdego tokenu wyjściowego zwróconego w elemecie content message . |
Nie. | Fałsz |
top_logprobs | integer | Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji tokenu, z których każde ma skojarzone prawdopodobieństwo dziennika.
logprobs musi być ustawiona na true wartość , jeśli ten parametr jest używany. |
Nie. | |
n | integer | Ile opcji ukończenia czatu ma być generowanych dla każdej wiadomości wejściowej. Pamiętaj, że opłaty będą naliczane na podstawie liczby wygenerowanych tokenów we wszystkich opcjach. Zachowaj n , 1 aby zminimalizować koszty. |
Nie. | 1 |
parallel_tool_calls | ParallelToolCalls | Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia. | Nie. | Prawda |
response_format | ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema | Obiekt określający format, który musi zostać wygenerowany przez model. Zgodność z GPT-4o, GPT-4o mini, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo nowszymi niż gpt-3.5-turbo-1106 . Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, które gwarantuje, że model będzie zgodny z podanym schematem JSON.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. | |
nasienie | integer | 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 system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu. |
Nie. | |
stream_options | chatCompletionStreamOptions | Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true |
Nie. | Brak |
tools | tablica | Lista narzędzi, które może wywołać model. Obecnie tylko funkcje są obsługiwane jako narzędzie. Służy do udostępniania listy funkcji, dla których model może generować dane wejściowe JSON. Obsługiwane są maksymalnie 128 funkcji. |
Nie. | |
tool_choice | chatCompletionToolChoiceOption | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.
none oznacza, że model nie wywoła żadnego narzędzia, a zamiast tego generuje komunikat.
auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia.
required oznacza, że model musi wywoływać co najmniej jedno narzędzie. Określenie określonego narzędzia za pośrednictwem {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.
none jest ustawieniem domyślnym, gdy żadne narzędzia nie są obecne.
auto jest wartością domyślną, jeśli istnieją narzędzia. |
Nie. | |
function_call | ciąg lub czatCompletionFunctionCallOption | Przestarzałe na rzecz .tool_choice Określa, która (jeśli istnieje) funkcja jest wywoływana przez model. none oznacza, że model nie wywoła funkcji, a zamiast tego generuje komunikat.auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem funkcji.Określenie określonej funkcji za pośrednictwem {"name": "my_function"} wymusza wywołanie tej funkcji przez model.none jest wartością domyślną, gdy nie ma żadnych funkcji.
auto jest wartością domyślną, jeśli funkcje są obecne. |
Nie. | |
— funkcje | tablica | Przestarzałe na rzecz .tools Lista funkcji, dla których model może generować dane wejściowe JSON. |
Nie. | |
user_security_context | userSecurityContext | Kontekst zabezpieczeń użytkownika zawiera kilka parametrów opisujących samą aplikację sztucznej inteligencji oraz użytkownika końcowego, który wchodzi w interakcję z aplikacją sztucznej inteligencji. Te pola ułatwiają zespołom ds. operacji zabezpieczeń badanie i eliminowanie zdarzeń zabezpieczeń, zapewniając kompleksowe podejście do ochrony aplikacji sztucznej inteligencji. Dowiedz się więcej o ochronie aplikacji sztucznej inteligencji przy użyciu Microsoft Defender dla Chmury. | Nie. |
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
application_name | string | Nazwa aplikacji. Poufne dane osobowe nie powinny być uwzględniane w tym polu. | Nie. | |
end_user_id | string | 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. | |
end_user_tenant_id | string | 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. | |
source_ip | string | Przechwytuje adres IP oryginalnego klienta, akceptując zarówno formatY IPv4, jak i IPv6. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
opis | string | Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję. | Nie. | |
nazwa | string | Nazwa funkcji do wywołania. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64. | Tak | |
parameters | Parametry funkcji | Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.
Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON, aby uzyskać dokumentację dotyczącą formatu. Pominięcie parameters definiuje funkcję z pustą listą parametrów. |
Nie. |
Określenie określonej funkcji za pośrednictwem {"name": "my_function"}
wymusza wywołanie tej funkcji przez model.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. | Tak |
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.
Ten składnik może być jednym z następujących elementów:
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | ciąg lub tablica | Zawartość komunikatu dla deweloperów. | Tak | |
role | wyliczenie | Rola autora komunikatów, w tym przypadku developer .Możliwe wartości: deweloper |
Tak | |
nazwa | string | Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | ciąg lub tablica | Zawartość komunikatu systemowego. | Tak | |
role | wyliczenie | Rola autora komunikatów, w tym przypadku system .Możliwe wartości: system |
Tak | |
nazwa | string | Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | ciąg lub tablica | Zawartość wiadomości użytkownika. |
Tak | |
role | wyliczenie | Rola autora komunikatów, w tym przypadku user .Możliwe wartości: użytkownik |
Tak | |
nazwa | string | Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | ciąg lub tablica | Zawartość komunikatu asystenta. Wymagane, chyba że tool_calls określono wartość lub function_call . |
Nie. | |
odmowa | string | Wiadomość o odmowie asystenta. | Nie. | |
role | wyliczenie | Rola autora komunikatów, w tym przypadku assistant .Możliwe wartości: asystent |
Tak | |
nazwa | string | Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli. | Nie. | |
tool_calls | chatCompletionMessageToolCalls | Wywołania narzędzia generowane przez model, takie jak wywołania funkcji. | Nie. | |
function_call | obiekt | Przestarzałe i zastąpione przez tool_calls . Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Argumenty | string | 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 generować parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
role | wyliczenie | Rola autora komunikatów, w tym przypadku tool .Możliwe wartości: narzędzie |
Tak | |
content | ciąg lub tablica | Zawartość komunikatu narzędzia. | Tak | |
tool_call_id | string | Wywołanie narzędzia, na które odpowiada ten komunikat. | Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
role | wyliczenie | Rola autora komunikatów, w tym przypadku function .Możliwe wartości: funkcja |
Tak | |
content | string | Zawartość komunikatu funkcji. | Tak | |
nazwa | string | Nazwa funkcji do wywołania. | Tak |
Ten składnik może być jednym z następujących elementów:
Ten składnik może być jednym z następujących elementów:
Ten składnik może być jednym z następujących elementów:
Ten składnik może być jednym z następujących elementów:
Ten składnik może być jednym z następujących elementów:
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ części zawartości. Możliwe wartości: tekst |
Tak | |
text | string | Zawartość tekstowa. | Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ części zawartości. Zawsze wartość input_audio .Możliwe wartości: input_audio |
Tak | |
input_audio | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
dane | string | Dane audio zakodowane w formacie Base64. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
format | string | Format zakodowanych danych dźwiękowych. Obecnie obsługuje "wav" i "mp3". |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ części zawartości. Możliwe wartości: image_url |
Tak | |
image_url | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Adres URL | string | Adres URL obrazu lub zakodowane w formacie base64 dane obrazu. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
szczegóły | string | Określa poziom szczegółowości obrazu. Dowiedz się więcej w przewodniku dotyczącym przetwarzania obrazów. | auto |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ części zawartości. Możliwe wartości: odmowa |
Tak | |
odmowa | string | Komunikat o odmowie wygenerowany przez model. | Tak |
Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | azureChatExtensionType | Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez czat uzupełnianie żądań, które powinny używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI. |
Tak |
Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.
Opis: reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez czat
uzupełnianie żądań, które powinny używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi.
Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: AzureChatExtensionType
Wartości wyliczenia:
Wartość | Opis |
---|---|
azure_search | Reprezentuje użycie usługi Azure Search jako rozszerzenia czatu usługi Azure OpenAI. |
azure_cosmos_db | Reprezentuje użycie usługi Azure Cosmos DB jako rozszerzenia czatu usługi Azure OpenAI. |
elasticsearch | Reprezentuje użycie indeksu Elasticsearch® jako rozszerzenia czatu usługi Azure OpenAI. |
mongo_db | Reprezentuje użycie bazy danych Mongo DB jako rozszerzenia czatu usługi Azure OpenAI. |
Pinecone | Reprezentuje użycie indeksu Pinecone jako rozszerzenia czatu usługi Azure OpenAI. |
Konkretna reprezentacja konfigurowalnych opcji usługi Azure Search podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | azureChatExtensionType | Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez czat uzupełnianie żądań, które powinny używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI. |
Tak | |
parameters | azureSearchChatExtensionParameters | Parametry usługi Azure Search, gdy są używane jako rozszerzenie czatu usługi Azure OpenAI. | Nie. |
Parametry usługi Azure Search, gdy są używane jako rozszerzenie czatu usługi Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
uwierzytelnianie | onYourDataApiKeyAuthenticationOptions lub onYourDataSystemAssignedManagedIdentityAuthenticationOptions lub onYourDataUserAssignedManagedIdentityAuthenticationOptions lub onYourDataAccessTokenAuthenticationOptions | Tak | ||
top_n_documents | integer | Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania. | Nie. | |
max_search_queries | integer | Maksymalna liczba przepisanych zapytań, które powinny być wysyłane do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania. | Nie. | |
allow_partial_result | boolean | Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem. | Nie. | Fałsz |
in_scope | boolean | Czy zapytania powinny być ograniczone do używania indeksowanych danych. | Nie. | |
ścisłość | integer | Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi. | Nie. | |
endpoint | string | Bezwzględna ścieżka punktu końcowego zasobu usługi Azure Search do użycia. | Tak | |
index_name | string | Nazwa indeksu, który ma być używany jako dostępny w przywoływowanym zasobie usługi Azure Search. | Tak | |
fields_mapping | azureSearchIndexFieldMappingOptions | Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu usługi Azure Search. | Nie. | |
query_type | azureSearchQueryType | Typ zapytania pobierania usługi Azure Search, który należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI. | Nie. | |
semantic_configuration | string | Dodatkowa konfiguracja semantyczna zapytania. | Nie. | |
filtr | string | Filtr wyszukiwania. | Nie. | |
embedding_dependency | onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource lub onYourDataIntegratedVectorizationSource | Nie. | ||
include_contexts | tablica | Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent . |
Nie. |
Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu usługi Azure Search.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
title_field | string | Nazwa pola indeksu, które ma być używane jako tytuł. | Nie. | |
url_field | string | Nazwa pola indeksu, które ma być używane jako adres URL. | Nie. | |
filepath_field | string | Nazwa pola indeksu do użycia jako ścieżka pliku. | Nie. | |
content_fields | tablica | Nazwy pól indeksu, które powinny być traktowane jako zawartość. | Nie. | |
content_fields_separator | string | Wzorzec separatora, którego powinny używać pola zawartości. | Nie. | |
vector_fields | tablica | Nazwy pól reprezentujących dane wektorowe. | Nie. | |
image_vector_fields | tablica | Nazwy pól reprezentujących dane wektorów obrazów. | Nie. |
Typ zapytania pobierania usługi Azure Search, który należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI.
Opis: typ zapytania pobierania usługi Azure Search, które należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: AzureSearchQueryType
Wartości wyliczenia:
Wartość | Opis |
---|---|
prosty | Reprezentuje domyślny, prosty analizator zapytań. |
semantyczne | Reprezentuje semantyczny analizator zapytań na potrzeby zaawansowanego modelowania semantycznego. |
wektor | Reprezentuje wyszukiwanie wektorów na podstawie obliczonych danych. |
vector_simple_hybrid | Reprezentuje kombinację prostej strategii zapytania z danymi wektorowymi. |
vector_semantic_hybrid | Reprezentuje kombinację semantycznego wyszukiwania i wykonywania zapytań dotyczących danych wektorowych. |
Konkretna reprezentacja konfigurowalnych opcji dla usługi Azure Cosmos DB w przypadku korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | azureChatExtensionType | Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez czat uzupełnianie żądań, które powinny używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI. |
Tak | |
parameters | azureCosmosDBChatExtensionParameters | Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI w czacie danych podczas korzystania z usługi Azure Cosmos DB dla Rdzenie wirtualne bazy danych MongoDB. |
Nie. |
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
uwierzytelnianie | onYourDataConnectionStringAuthenticationOptions | Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z parametry połączenia. | Tak | |
top_n_documents | integer | Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania. | Nie. | |
max_search_queries | integer | 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. | |
allow_partial_result | boolean | Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem. | Nie. | Fałsz |
in_scope | boolean | Czy zapytania powinny być ograniczone do używania indeksowanych danych. | Nie. | |
ścisłość | integer | Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi. | Nie. | |
database_name | string | Nazwa bazy danych mongoDB z rdzeniami wirtualnymi do użycia z usługą Azure Cosmos DB. | Tak | |
container_name | string | Nazwa kontenera zasobów usługi Azure Cosmos DB. | Tak | |
index_name | string | Nazwa indeksu rdzeni wirtualnych bazy danych MongoDB do użycia z usługą Azure Cosmos DB. | Tak | |
fields_mapping | azureCosmosDBFieldMappingOptions | Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu usługi Azure Cosmos DB. | Tak | |
embedding_dependency | onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource | Tak | ||
include_contexts | tablica | Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent . |
Nie. |
Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu usługi Azure Cosmos DB.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
title_field | string | Nazwa pola indeksu, które ma być używane jako tytuł. | Nie. | |
url_field | string | Nazwa pola indeksu, które ma być używane jako adres URL. | Nie. | |
filepath_field | string | Nazwa pola indeksu do użycia jako ścieżka pliku. | Nie. | |
content_fields | tablica | Nazwy pól indeksu, które powinny być traktowane jako zawartość. | Tak | |
content_fields_separator | string | Wzorzec separatora, którego powinny używać pola zawartości. | Nie. | |
vector_fields | tablica | Nazwy pól reprezentujących dane wektorowe. | Tak |
Konkretna reprezentacja konfigurowalnych opcji usługi Elasticsearch podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | azureChatExtensionType | Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez czat uzupełnianie żądań, które powinny używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI. |
Tak | |
parameters | elasticsearchChatExtensionParameters | Parametry do użycia podczas konfigurowania usługi Elasticsearch® jako rozszerzenia czatu usługi Azure OpenAI. | Nie. |
Parametry do użycia podczas konfigurowania usługi Elasticsearch® jako rozszerzenia czatu usługi Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
uwierzytelnianie | onYourDataKeyAndKeyIdAuthenticationOptions lub onYourDataEncodedApiKeyAuthenticationOptions | Tak | ||
top_n_documents | integer | Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania. | Nie. | |
max_search_queries | integer | Maksymalna liczba przepisanych zapytań, które powinny być wysyłane do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania. | Nie. | |
allow_partial_result | boolean | Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem. | Nie. | Fałsz |
in_scope | boolean | Czy zapytania powinny być ograniczone do używania indeksowanych danych. | Nie. | |
ścisłość | integer | Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi. | Nie. | |
endpoint | string | Punkt końcowy usługi Elasticsearch®. | Tak | |
index_name | string | Nazwa indeksu elasticsearch®. | Tak | |
fields_mapping | elasticsearchIndexFieldMappingOptions | Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu elasticsearch®. | Nie. | |
query_type | elasticsearchQueryType | Typ zapytania pobierania elasticsearch®, które należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI. | Nie. | |
embedding_dependency | onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource lub onYourDataModelIdVectorizationSource | Nie. | ||
include_contexts | tablica | Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent . |
Nie. |
Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu elasticsearch®.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
title_field | string | Nazwa pola indeksu, które ma być używane jako tytuł. | Nie. | |
url_field | string | Nazwa pola indeksu, które ma być używane jako adres URL. | Nie. | |
filepath_field | string | Nazwa pola indeksu do użycia jako ścieżka pliku. | Nie. | |
content_fields | tablica | Nazwy pól indeksu, które powinny być traktowane jako zawartość. | Nie. | |
content_fields_separator | string | Wzorzec separatora, którego powinny używać pola zawartości. | Nie. | |
vector_fields | tablica | Nazwy pól reprezentujących dane wektorowe. | Nie. |
Typ zapytania pobierania elasticsearch®, które należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI.
Opis: typ zapytania pobierania elasticsearch®, który należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: ElasticsearchQueryType
Wartości wyliczenia:
Wartość | Opis |
---|---|
prosty | Reprezentuje domyślny, prosty analizator zapytań. |
wektor | Reprezentuje wyszukiwanie wektorów na podstawie obliczonych danych. |
Konkretna reprezentacja konfigurowalnych opcji bazy danych Mongo DB podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | azureChatExtensionType | Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez czat uzupełnianie żądań, które powinny używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI. |
Tak | |
parameters | mongoDBChatExtensionParameters | Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI na czacie danych podczas korzystania z bazy danych Mongo DB. | Nie. |
Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI na czacie danych podczas korzystania z bazy danych Mongo DB.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
uwierzytelnianie | onYourDataUsernameAndPasswordAuthenticationOptions | Opcje uwierzytelniania dla usługi Azure OpenAI On Your Data podczas korzystania z nazwy użytkownika i hasła. | Tak | |
top_n_documents | integer | Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania. | Nie. | |
max_search_queries | integer | Maksymalna liczba przepisanych zapytań, które powinny być wysyłane do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania. | Nie. | |
allow_partial_result | boolean | Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem. | Nie. | Fałsz |
in_scope | boolean | Czy zapytania powinny być ograniczone do używania indeksowanych danych. | Nie. | |
ścisłość | integer | Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi. | Nie. | |
endpoint | string | Nazwa punktu końcowego klastra bazy danych Mongo DB. | Tak | |
database_name | string | Nazwa bazy danych Mongo DB. | Tak | |
collection_name | string | Nazwa kolekcji mongo DB. | Tak | |
app_name | string | Nazwa aplikacji mongo DB. | Tak | |
index_name | string | Nazwa indeksu bazy danych Mongo DB. | Tak | |
fields_mapping | mongoDBFieldMappingOptions | Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu bazy danych Mongo DB. | Tak | |
embedding_dependency | onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource | Tak | ||
include_contexts | tablica | Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent . |
Nie. |
Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu bazy danych Mongo DB.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
title_field | string | Nazwa pola indeksu, które ma być używane jako tytuł. | Nie. | |
url_field | string | Nazwa pola indeksu, które ma być używane jako adres URL. | Nie. | |
filepath_field | string | Nazwa pola indeksu do użycia jako ścieżka pliku. | Nie. | |
content_fields | tablica | Nazwy pól indeksu, które powinny być traktowane jako zawartość. | Tak | |
content_fields_separator | string | Wzorzec separatora, którego powinny używać pola zawartości. | Nie. | |
vector_fields | tablica | Nazwy pól reprezentujących dane wektorowe. | Tak |
Konkretna reprezentacja konfigurowalnych opcji pinecone podczas korzystania z niej jako rozszerzenia czatu Usługi Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | azureChatExtensionType | Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez czat uzupełnianie żądań, które powinny używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI. |
Tak | |
parameters | pineconeChatExtensionParameters | Parametry konfigurowania rozszerzeń czatu Pinecone w usłudze Azure OpenAI. | Nie. |
Parametry konfigurowania rozszerzeń czatu Pinecone w usłudze Azure OpenAI.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
uwierzytelnianie | onYourDataApiKeyAuthenticationOptions | Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z klucza interfejsu API. | Tak | |
top_n_documents | integer | Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania. | Nie. | |
max_search_queries | integer | Maksymalna liczba przepisanych zapytań, które powinny być wysyłane do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania. | Nie. | |
allow_partial_result | boolean | Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem. | Nie. | Fałsz |
in_scope | boolean | Czy zapytania powinny być ograniczone do używania indeksowanych danych. | Nie. | |
ścisłość | integer | Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi. | Nie. | |
Środowisko usługi | string | Nazwa środowiska Pinecone. | Tak | |
index_name | string | Nazwa indeksu bazy danych Pinecone. | Tak | |
fields_mapping | pineconeFieldMappingOptions | Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu Pinecone. | Tak | |
embedding_dependency | onYourDataDeploymentNameVectorizationSource | Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na na wewnętrznej nazwie wdrożenia modelu osadzania w tym samym zasobie usługi Azure OpenAI. |
Tak | |
include_contexts | tablica | Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent . |
Nie. |
Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu Pinecone.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
title_field | string | Nazwa pola indeksu, które ma być używane jako tytuł. | Nie. | |
url_field | string | Nazwa pola indeksu, które ma być używane jako adres URL. | Nie. | |
filepath_field | string | Nazwa pola indeksu do użycia jako ścieżka pliku. | Nie. | |
content_fields | tablica | Nazwy pól indeksu, które powinny być traktowane jako zawartość. | Tak | |
content_fields_separator | string | Wzorzec separatora, którego powinny używać pola zawartości. | Nie. |
Opcje uwierzytelniania dla usługi Azure OpenAI On Your Data.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak |
Właściwość kontekstu.
Opis: właściwość kontekstu.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: OnYourDataContextProperty
Wartości wyliczenia:
Wartość | Opis |
---|---|
Cytatów | Właściwość citations . |
Intencja | Właściwość intent . |
all_retrieved_documents | Właściwość all_retrieved_documents . |
Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.
Opis: Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: OnYourDataAuthenticationType
Wartości wyliczenia:
Wartość | Opis |
---|---|
api_key | Uwierzytelnianie za pośrednictwem klucza interfejsu API. |
connection_string | Uwierzytelnianie za pośrednictwem parametry połączenia. |
key_and_key_id | Uwierzytelnianie za pomocą pary kluczy i identyfikatora klucza. |
encoded_api_key | Uwierzytelnianie za pomocą zakodowanego klucza interfejsu API. |
access_token | Uwierzytelnianie za pośrednictwem tokenu dostępu. |
system_assigned_managed_identity | Uwierzytelnianie za pośrednictwem tożsamości zarządzanej przypisanej przez system. |
user_assigned_managed_identity | Uwierzytelnianie za pośrednictwem tożsamości zarządzanej przypisanej przez użytkownika. |
username_and_password | Uwierzytelnianie za pomocą nazwy użytkownika i hasła. |
Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z klucza interfejsu API.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak | |
klucz | string | Klucz interfejsu API do użycia do uwierzytelniania. | Nie. |
Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z parametry połączenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak | |
connection_string | string | Parametry połączenia do użycia do uwierzytelniania. | Nie. |
Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z pary kluczy Elasticsearch i identyfikatora klucza.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak | |
klucz | string | Klucz elasticsearch do użycia do uwierzytelniania. | Nie. | |
key_id | string | Identyfikator klucza elasticsearch do użycia do uwierzytelniania. | Nie. |
Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z klucza interfejsu API zakodowanego w usłudze Elasticsearch.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak | |
encoded_api_key | string | Klucz interfejsu API zakodowanego w usłudze Elasticsearch do użycia na potrzeby uwierzytelniania. | Nie. |
Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z tokenu dostępu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak | |
access_token | string | Token dostępu do użycia do uwierzytelniania. | Nie. |
Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z tożsamości zarządzanej przypisanej przez system.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak |
Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z tożsamości zarządzanej przypisanej przez użytkownika.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak | |
managed_identity_resource_id | string | Identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika do użycia do uwierzytelniania. | Nie. |
Opcje uwierzytelniania dla usługi Azure OpenAI On Your Data podczas korzystania z nazwy użytkownika i hasła.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataAuthenticationType | Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych. | Tak | |
nazwa użytkownika | string | Nazwa użytkownika używana do uwierzytelniania. | Nie. | |
hasło | string | Hasło. do użycia do uwierzytelniania. | Nie. |
Abstrakcyjna reprezentacja źródła wektoryzacji dla usługi Azure OpenAI On Your Data z wyszukiwaniem wektorowym.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataVectorizationSourceType | Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data mogą służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwanie wektorów. |
Tak |
Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.
Opis: Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data mogą służyć do konfigurowania wektoryzacji danych do użycia z
wyszukiwanie wektorów.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: OnYourDataVectorizationSourceType
Wartości wyliczenia:
Wartość | Opis |
---|---|
endpoint | Reprezentuje wektoryzację wykonywaną przez wywołania usług publicznych do modelu osadzania usługi Azure OpenAI. |
deployment_name | Reprezentuje nazwę wdrożenia modelu Ada do użycia. To wdrożenie modelu musi znajdować się w tym samym zasobie usługi Azure OpenAI, ale Na danych użyje tego wdrożenia modelu za pośrednictwem wywołania wewnętrznego, a nie publicznego, co umożliwia wektor wyszukiwanie nawet w sieciach prywatnych. |
zintegrowany | Reprezentuje zintegrowany wektoryzator zdefiniowany w ramach zasobu wyszukiwania. |
model_id | Reprezentuje określony identyfikator modelu osadzania zgodnie z definicją w usłudze wyszukiwania. Obecnie obsługiwane tylko przez usługę Elasticsearch®. |
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataVectorizationSourceType | Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data mogą służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwanie wektorów. |
Tak | |
endpoint | string | 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. | |
uwierzytelnianie | onYourDataApiKeyAuthenticationOptions lub onYourDataAccessTokenAuthenticationOptions | Nie. | ||
wymiary | integer | Liczba wymiarów osadzania powinna mieć wartość . Obsługiwane tylko w text-embedding-3 modelach i nowszych. |
Nie. |
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataVectorizationSourceType | Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data mogą służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwanie wektorów. |
Tak | |
deployment_name | string | Określa nazwę wdrożenia modelu do użycia na potrzeby wektoryzacji. To wdrożenie modelu musi znajdować się w tym samym zasobie usługi Azure OpenAI, ale w danych będzie używać tego wdrożenia modelu za pośrednictwem wywołania wewnętrznego, a nie publicznego, co umożliwia wyszukiwanie wektorów nawet w sieciach prywatnych. | Nie. | |
wymiary | integer | Liczba wymiarów osadzania powinna mieć wartość . Obsługiwane tylko w text-embedding-3 modelach i nowszych. |
Nie. |
Reprezentuje zintegrowany wektoryzator zdefiniowany w ramach zasobu wyszukiwania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataVectorizationSourceType | Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data mogą służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwanie wektorów. |
Tak |
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 usługę Elasticsearch®.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | onYourDataVectorizationSourceType | Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data mogą służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwanie wektorów. |
Tak | |
model_id | string | Określa identyfikator modelu, który ma być używany do wektoryzacji. Ten identyfikator modelu musi być zdefiniowany w usłudze wyszukiwania. | Nie. |
Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy rozszerzenia czatu usługi Azure OpenAI są zaangażowane w generowanie odpowiedniej odpowiedzi na czat. Te informacje kontekstowe są wypełniane tylko w przypadku używania żądania usługi Azure OpenAI skonfigurowanego do używania zgodnego rozszerzenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Cytatów | tablica | Wynik pobierania źródła danych używany do generowania komunikatu asystenta w odpowiedzi. | Nie. | |
Intencja | string | Wykryta intencja z historii czatu użyta do przekazania do następnego kroku w celu przeniesienia kontekstu. | Nie. | |
all_retrieved_documents | tablica | Wszystkie pobrane dokumenty. | Nie. |
informacje o cytatach dla komunikatu odpowiedzi zakończenia czatu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | string | Zawartość cytatu. | Tak | |
title | string | Tytuł cytatu. | Nie. | |
Adres URL | string | Adres URL cytatu. | Nie. | |
ścieżka pliku | string | Ścieżka pliku cytatu. | Nie. | |
chunk_id | string | Identyfikator fragmentu cytatu. | Nie. | |
rerank_score | Liczba | Wynik ponownego generowania pobranego dokumentu. | Nie. |
Pobrany dokument.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | string | Zawartość cytatu. | Tak | |
title | string | Tytuł cytatu. | Nie. | |
Adres URL | string | Adres URL cytatu. | Nie. | |
ścieżka pliku | string | Ścieżka pliku cytatu. | Nie. | |
chunk_id | string | Identyfikator fragmentu cytatu. | Nie. | |
rerank_score | Liczba | Wynik ponownego generowania pobranego dokumentu. | Nie. | |
search_queries | tablica | Zapytania wyszukiwania używane do pobierania dokumentu. | Nie. | |
data_source_index | integer | Indeks źródła danych. | Nie. | |
original_search_score | Liczba | Oryginalny wynik wyszukiwania pobranego dokumentu. | Nie. | |
filter_reason | filterReason | Przyczyna filtrowania pobranego dokumentu. | Nie. |
Przyczyna filtrowania pobranego dokumentu.
Opis: przyczyna filtrowania pobranego dokumentu.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: FilterReason
Wartości wyliczenia:
Wartość | Opis |
---|---|
score | Dokument jest filtrowany według oryginalnego progu oceny wyszukiwania zdefiniowanego przez strictness konfigurację. |
ponów próbę | Dokument nie jest filtrowany według oryginalnego progu wyników wyszukiwania, ale jest filtrowany według wyników ponownego generowania i top_n_documents konfigurowania. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator wywołania narzędzia. | Tak | |
type | toolCallType | W tym przypadku function typ wywołania narzędzia . |
Tak | |
function | obiekt | Funkcja wywoływana przez model. | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Argumenty | string | 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 generować parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie. |
W tym przypadku function
typ wywołania narzędzia .
Opis: typ wywołania narzędzia, w tym przypadku function
.
Typ: ciąg
Domyślnie:
Nazwa wyliczenia: ToolCallType
Wartości wyliczenia:
Wartość | Opis |
---|---|
function | Typ wywołania narzędzia to funkcja. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
tool_call_id | string | Wywołanie narzędzia, na które odpowiada ten komunikat. | Nie. | |
content | string | Zawartość wiadomości. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
role | wyliczenie | Rola autora komunikatów, w tym przypadku function .Możliwe wartości: funkcja |
Nie. | |
nazwa | string | Zawartość wiadomości. | Nie. | |
content | string | Zawartość wiadomości. | Nie. |
Reprezentuje odpowiedź ukończenia czatu zwróconą przez model na podstawie podanych danych wejściowych.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Unikatowy identyfikator ukończenia czatu. | Tak | |
prompt_filter_results | promptFilterResults | Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych monitów mogą pojawiać się w różnych porach lub w różnych zamówieniach. | Nie. | |
Wyborów | tablica | Lista opcji ukończenia czatu. Może być więcej niż jeden, jeśli n jest większy niż 1. |
Tak | |
utworzone | integer | Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia czatu. | Tak | |
model | string | Model używany do ukończenia czatu. | Tak | |
system_fingerprint | string | Ten odcisk palca reprezentuje konfigurację zaplecza, z którą działa model. Można użyć w połączeniu z parametrem seed żądania, aby zrozumieć, kiedy wprowadzono zmiany zaplecza, które mogą mieć wpływ na determinizm. |
Nie. | |
obiekt | wyliczenie | Typ obiektu, który jest zawsze chat.completion .Możliwe wartości: chat.completion |
Tak | |
użycie | completionUsage | Statystyki użycia dla żądania ukończenia. | Nie. |
Reprezentuje strumień fragmentu odpowiedzi ukończenia czatu zwróconej przez model na podstawie podanych danych wejściowych.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Unikatowy identyfikator ukończenia czatu. Każdy fragment ma ten sam identyfikator. | Tak | |
Wyborów | tablica | Lista opcji ukończenia czatu. Może zawierać więcej niż jeden element, jeśli n jest większy niż 1. |
Tak | |
utworzone | integer | Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia czatu. Każdy fragment ma ten sam znacznik czasu. | Tak | |
model | string | Model do wygenerowania ukończenia. | Tak | |
system_fingerprint | string | Ten odcisk palca reprezentuje konfigurację zaplecza, z którą działa model. Można użyć w połączeniu z parametrem seed żądania, aby zrozumieć, kiedy wprowadzono zmiany zaplecza, które mogą mieć wpływ na determinizm. |
Nie. | |
obiekt | wyliczenie | Typ obiektu, który jest zawsze chat.completion.chunk .Możliwe wartości: chat.completion.chunk |
Tak |
Delta ukończenia czatu wygenerowana przez przesyłane strumieniowo odpowiedzi modelu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | string | Zawartość komunikatu fragmentu. | Nie. | |
function_call | obiekt | Przestarzałe i zastąpione przez tool_calls . Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model. |
Nie. | |
tool_calls | tablica | Nie. | ||
role | wyliczenie | Rola autora tej wiadomości. Możliwe wartości: system, użytkownik, asystent, narzędzie |
Nie. | |
odmowa | string | Komunikat o odmowie wygenerowany przez model. | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Argumenty | string | 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 generować parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Tak | ||
identyfikator | string | Identyfikator wywołania narzędzia. | Nie. | |
type | wyliczenie | Typ narzędzia. Obecnie obsługiwane są tylko function te elementy.Możliwe wartości: funkcja |
Nie. | |
function | obiekt | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Argumenty | string | 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 generować parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie. |
Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
include_usage | boolean | W przypadku ustawienia przed komunikatem data: [DONE] zostanie przesłany strumień dodatkowy fragment. Pole usage w tym fragmentzie pokazuje statystyki użycia tokenu dla całego żądania, a choices pole zawsze będzie pustą tablicą. Wszystkie inne fragmenty będą również zawierać usage pole, ale z wartością null. |
Nie. |
Informacje o prawdopodobieństwie rejestrowania dla wybranego elementu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
content | tablica | Lista tokenów zawartości komunikatów z informacjami o prawdopodobieństwa dziennika. | Tak | |
odmowa | tablica | Lista tokenów odmowy wiadomości z informacjami o prawdopodobieństwa dziennika. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
token | string | Token. | Tak | |
logprob | Liczba | Prawdopodobieństwo dziennika tego tokenu. | Tak | |
B | tablica | 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 dla tokenu nie ma reprezentacji bajtów. |
Tak | |
top_logprobs | tablica | Lista najbardziej prawdopodobnych tokenów i ich prawdopodobieństwa dziennika na tej pozycji tokenu. W rzadkich przypadkach może być mniej niż liczba zwróconych żądań top_logprobs . |
Tak |
Komunikat ukończenia czatu wygenerowany przez model.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
role | chatCompletionResponseMessageRole | Rola autora komunikatu odpowiedzi. | Tak | |
odmowa | string | Komunikat o odmowie wygenerowany przez model. | Tak | |
content | string | Zawartość wiadomości. | Tak | |
tool_calls | tablica | Wywołania narzędzia generowane przez model, takie jak wywołania funkcji. | Nie. | |
function_call | chatCompletionFunctionCall | Przestarzałe i zastąpione przez tool_calls . Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model. |
Nie. | |
dźwięk | obiekt | Jeśli zażądano modalności danych wyjściowych dźwięku, ten obiekt zawiera dane informacje o odpowiedzi audio z modelu. |
Nie. | |
kontekst | azureChatExtensionsMessageContext | Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy są zaangażowane rozszerzenia czatu usługi Azure OpenAI w generacji odpowiadającej odpowiedzi na ukończenie czatu. Te informacje kontekstowe są wypełniane tylko wtedy, gdy przy użyciu żądania usługi Azure OpenAI skonfigurowanego do używania zgodnego rozszerzenia. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
identyfikator | string | Unikatowy identyfikator tej odpowiedzi audio. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
expires_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu, gdy ta odpowiedź dźwiękowa nie są już dostępne na serwerze do użycia w wielu trybach Rozmowy. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
dane | string | Zakodowane bajty audio zakodowane w formacie Base64 wygenerowane przez model określone w żądaniu. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
transkrypcja | string | Transkrypcja dźwięku wygenerowanego przez model. |
Rola autora komunikatu odpowiedzi.
Opis: rola autora komunikatu odpowiedzi.
Typ: ciąg
Domyślnie:
Wartości wyliczenia:
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.
Ten składnik może być jednym z następujących elementów:
Określa narzędzie, które ma być używane przez model. Użyj polecenia , aby wymusić wywołanie określonej funkcji przez model.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ narzędzia. Obecnie obsługiwane są tylko function te elementy.Możliwe wartości: funkcja |
Tak | |
function | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. |
Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.
Brak zdefiniowanych właściwości dla tego składnika.
Statyczna przewidywana zawartość wyjściowa, taka jak zawartość pliku tekstowego, który jest ponownie wygenerowany.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ przewidywanej zawartości, którą chcesz podać. Ten typ jest obecnie zawsze content .Możliwe wartości: zawartość |
Tak | |
content | 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 |
Wywołania narzędzia generowane przez model, takie jak wywołania funkcji.
Brak zdefiniowanych właściwości dla tego składnika.
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.
Przestarzałe i zastąpione przez tool_calls
. Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. | Tak | |
Argumenty | string | 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 generować parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie. | Tak |
Statystyki użycia dla żądania ukończenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
prompt_tokens | integer | Liczba tokenów w wierszu polecenia. | Tak | |
completion_tokens | integer | Liczba tokenów w wygenerowanych ukończeniu. | Tak | |
total_tokens | integer | Łączna liczba tokenów używanych w żądaniu (monit + ukończenie). | Tak | |
prompt_tokens_details | obiekt | Szczegóły tokenów monitu. | Nie. | |
completion_tokens_details | obiekt | Podział tokenów używanych w zakończeniu. | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
audio_tokens | integer | Tokeny wejściowe audio obecne w wierszu polecenia. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
cached_tokens | integer | Liczba buforowanych tokenów monitów. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
accepted_prediction_tokens | integer | W przypadku korzystania z przewidywanych danych wyjściowych liczba tokenów w przewidywaniu, które pojawiło się w zakończeniu. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
audio_tokens | integer | Tokeny wejściowe audio generowane przez model. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
reasoning_tokens | integer | Tokeny generowane przez model z powodów. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
rejected_prediction_tokens | integer | 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. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ narzędzia. Obecnie obsługiwane są tylko function te elementy.Możliwe wartości: funkcja |
Tak | |
function | FunctionObject | Tak |
Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON, aby uzyskać dokumentację dotyczącą formatu.
Pominięcie parameters
definiuje funkcję z pustą listą parametrów.
Brak zdefiniowanych właściwości dla tego składnika.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
opis | string | Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję. | Nie. | |
nazwa | string | Nazwa funkcji do wywołania. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64. | Tak | |
parameters | Parametry funkcji | Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.
Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON, aby uzyskać dokumentację dotyczącą formatu. Pominięcie parameters definiuje funkcję z pustą listą parametrów. |
Nie. | |
ściśle | boolean | Czy włączyć ścisłe przestrzeganie schematu podczas generowania wywołania funkcji. Jeśli ustawiono wartość true, model będzie postępować zgodnie z dokładnym schematem zdefiniowanym parameters w polu. Tylko podzbiór schematu JSON jest obsługiwany, gdy strict ma wartość true . |
Nie. | Fałsz |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ zdefiniowanego formatu odpowiedzi: text Możliwe wartości: tekst |
Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ zdefiniowanego formatu odpowiedzi: json_object Możliwe wartości: json_object |
Tak |
Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.
Brak zdefiniowanych właściwości dla tego składnika.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Typ zdefiniowanego formatu odpowiedzi: json_schema Możliwe wartości: json_schema |
Tak | |
json_schema | obiekt | Tak |
Nazwa/nazwisko | Pisz | Opis | Domyślny |
---|---|---|---|
opis | string | Opis formatu odpowiedzi używany przez model do określenia sposobu reagowania w formacie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa formatu odpowiedzi. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
schema | ResponseFormatJsonSchemaSchema | Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
ściśle | boolean | Czy włączyć ścisłe przestrzeganie schematu podczas generowania danych wyjściowych. W przypadku ustawienia wartości true model będzie zawsze przestrzegał dokładnego schematu zdefiniowanego schema w polu. Tylko podzbiór schematu JSON jest obsługiwany, gdy strict ma wartość true . |
Fałsz |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Nie. | ||
finish_reason | string | Nie |
Żądanie tłumaczenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
plik | string | Plik audio do tłumaczenia. | Tak | |
monit | string | Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być w języku angielskim. | Nie. | |
response_format | audioResponseFormat | Definiuje format danych wyjściowych. | Nie. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model użyje prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu trafienia określonych progów. | Nie. | 0 |
Odpowiedź tłumaczenia lub transkrypcji, gdy response_format był w formacie JSON
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
text | string | Przetłumaczony lub transkrypowany tekst. | Tak |
Odpowiedź tłumaczenia lub transkrypcji, gdy response_format była verbose_json
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
text | string | Przetłumaczony lub transkrypowany tekst. | Tak | |
task | string | Typ zadania audio. | Nie. | |
język | string | Język. | Nie. | |
czas trwania | Liczba | Czas trwania. | Nie. | |
segmenty | tablica | Nie. | ||
słowa | tablica | Nie. |
Definiuje format danych wyjściowych.
Opis: definiuje format danych wyjściowych.
Typ: ciąg
Domyślnie:
Wartości wyliczenia:
Żądanie transkrypcji.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
plik | string | Obiekt pliku audio do transkrypcji. | Tak | |
monit | string | Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być zgodny z językiem dźwięku. | Nie. | |
response_format | audioResponseFormat | Definiuje format danych wyjściowych. | Nie. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model użyje prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu trafienia określonych progów. | Nie. | 0 |
język | string | Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 poprawi dokładność i opóźnienie. | Nie. | |
timestamp_granularities[] | tablica | Stopień szczegółowości sygnatury czasowej do wypełnienia dla tej transkrypcji.
response_format należy ustawić, verbose_json aby używać szczegółowości sygnatury czasowej. Obsługiwane są obie te opcje: word , lub segment . Uwaga: nie ma dodatkowego opóźnienia dla sygnatur czasowych segmentu, ale generowanie znaczników czasu wyrazów powoduje dodatkowe opóźnienie. |
Nie. | ['segment'] |
Transkrypcja lub segment tłumaczenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | integer | Identyfikator segmentu. | Nie. | |
szukać | Liczba | Przesunięcie segmentu. | Nie. | |
start | Liczba | Przesunięcie rozpoczęcia segmentu. | Nie. | |
end | Liczba | Przesunięcie końcowe segmentu. | Nie. | |
text | string | Tekst segmentu. | Nie. | |
Tokeny | tablica | Tokeny tekstu. | Nie. | |
temperature | Liczba | Temperatura. | Nie. | |
avg_logprob | Liczba | Średnie prawdopodobieństwo dziennika. | Nie. | |
compression_ratio | Liczba | Sprężania. | Nie. | |
no_speech_prob | Liczba | Prawdopodobieństwo braku mowy. | Nie. |
Transkrypcja lub słowo translacji.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
słowo | string | Word | Nie. | |
start | Liczba | Przesunięcie rozpoczęcia programu Word. | Nie. | |
end | Liczba | Przesunięcie końcowe programu Word. | Nie. |
Żądanie mowy.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
dane_wejściowe | string | Tekst do syntezowania dźwięku. Maksymalna długość to 4096 znaków. | Tak | |
voice | wyliczenie | Głos używany do syntezy mowy. Możliwe wartości: stop, echo, fable, onyx, nova, shimmer |
Tak | |
response_format | wyliczenie | Format syntetyzowania dźwięku. Możliwe wartości: mp3, opus, aac, flac, wav, pcm |
Nie. | |
szybkość | Liczba | Szybkość syntetyzowanego dźwięku. Wybierz wartość z 0.25 do 4.0 . Wartość domyślna to 1.0 . |
Nie. | 1.0 |
Jakość obrazu, który zostanie wygenerowany.
Opis: jakość obrazu, który zostanie wygenerowany.
Typ: ciąg
Wartość domyślna: standardowa
Nazwa wyliczenia: Jakość
Wartości wyliczenia:
Wartość | Opis |
---|---|
standardowa | Standardowa jakość tworzy obrazy o standardowej jakości. |
Hd | Jakość hd tworzy obrazy z bardziej szczegółowymi szczegółami i większą spójnością na obrazie. |
Format, w którym są zwracane wygenerowane obrazy.
Opis: format, w którym są zwracane wygenerowane obrazy.
Typ: ciąg
Ustawienie domyślne: adres URL
Nazwa wyliczenia: ImagesResponseFormat
Wartości wyliczenia:
Wartość | Opis |
---|---|
Adres URL | Adres URL, który zapewnia tymczasowy dostęp do pobierania wygenerowanych obrazów. |
b64_json | Wygenerowane obrazy są zwracane jako ciąg zakodowany w formacie base64. |
Rozmiar wygenerowanych obrazów.
Opis: rozmiar wygenerowanych obrazów.
Typ: ciąg
Ustawienie domyślne: 1024x1024
Nazwa wyliczenia: rozmiar
Wartości wyliczenia:
Wartość | Opis |
---|---|
256x256 | Żądany rozmiar wygenerowanego obrazu to 256 x 256 pikseli. Obsługiwane tylko dla dall-e-2. |
512x512 | Żądany rozmiar wygenerowanego obrazu to 512 x 512 pikseli. Obsługiwane tylko dla dall-e-2. |
1792x1024 | Żądany rozmiar wygenerowanego obrazu to 1792 x 1024 pikseli. Obsługiwane tylko dla dall-e-3. |
1024x1792 | Żądany rozmiar wygenerowanego obrazu to 1024 x 1792 pikseli. Obsługiwane tylko dla dall-e-3. |
1024x1024 | Żądany rozmiar wygenerowanego obrazu to 1024 x 1024 pikseli. |
Styl wygenerowanych obrazów.
Opis: styl wygenerowanych obrazów.
Typ: ciąg
Ustawienie domyślne: żywe
Nazwa wyliczenia: styl
Wartości wyliczenia:
Wartość | Opis |
---|---|
żywy | Vivid tworzy obrazy, które są hiperrealistyczne i dramatyczne. |
naturalny | Naturalne tworzy obrazy, które są bardziej naturalne i mniej hiperrealistyczne. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
monit | string | Opis tekstu żądanych obrazów. Maksymalna długość to 4000 znaków. | Tak | |
n | integer | Liczba obrazów do wygenerowania. | Nie. | 1 |
size | imageSize | Rozmiar wygenerowanych obrazów. | Nie. | 1024x1024 |
response_format | imagesResponseFormat | Format, w którym są zwracane wygenerowane obrazy. | Nie. | Adres URL |
Użytkownik | string | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć. | Nie. | |
jakość | imageQuality | Jakość obrazu, który zostanie wygenerowany. | Nie. | standardowa |
— styl | imageStyle | Styl wygenerowanych obrazów. | Nie. | żywy |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
utworzone | integer | Sygnatura czasowa systemu unix podczas tworzenia operacji. | Tak | |
dane | tablica | Dane wynikowe operacji, jeśli operacja zakończyła się pomyślnie | Tak |
Adres URL obrazu lub zakodowany obraz, jeśli się powiedzie, i błąd w przeciwnym razie.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
Adres URL | string | Adres URL obrazu. | Nie. | |
b64_json | string | Obraz zakodowany w formacie base64 | Nie. | |
content_filter_results | dalleContentFilterResults | Informacje o wynikach filtrowania zawartości. | Nie. | |
revised_prompt | string | Monit, który został użyty do wygenerowania obrazu, jeśli wystąpiła jakakolwiek poprawka do monitu. | Nie. | |
prompt_filter_results | dalleFilterResults | Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator. | Nie. |
Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
text | string | Tak | ||
Obejmuje | tablica | Tablica zakresów reprezentujących wykryte obiekty i informacje o polu ograniczenia. | Tak |
Obiekt span reprezentujący wykryty obiekt i informacje o polu ograniczenia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
text | string | Zawartość tekstowa zakresu reprezentująca wykryty obiekt. | Tak | |
offset | integer | 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 | |
length | integer | Długość zakresu w znakach mierzona w punktach kodu Unicode. | Tak | |
wielokąt | tablica | Tablica obiektów reprezentujących punkty w wielokącie, który otacza wykryty obiekt. | Tak |
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
, queued
itp.).
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
completion_tokens | integer | Liczba tokenów ukończenia używanych w trakcie przebiegu. | Tak | |
prompt_tokens | integer | Liczba tokenów monitu używanych w trakcie przebiegu. | Tak | |
total_tokens | integer | Łączna liczba użytych tokenów (monit i ukończenie). | Tak |
Statystyki użycia związane z krokiem uruchamiania. Ta wartość będzie mieć null
stan , gdy stan kroku uruchomienia to in_progress
.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
completion_tokens | integer | Liczba tokenów ukończenia używanych w trakcie kroku uruchamiania. | Tak | |
prompt_tokens | integer | Liczba tokenów monitu używanych w trakcie kroku uruchamiania. | Tak | |
total_tokens | integer | Łączna liczba użytych tokenów (monit i ukończenie). | Tak |
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 w celu { "type": "json_schema", "json_schema": {...} }
włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.
Ustawienie w celu { "type": "json_object" }
włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.
Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length"
, co wskazuje, że generacja przekroczyła max_tokens
lub konwersacja przekroczyła maksymalną długość kontekstu.
Ten składnik może być jednym z następujących elementów:
Obiekt opisujący oczekiwane dane wyjściowe modelu. Jeśli json_object
tylko typ tools
może zostać przekazany do function
przebiegu. Jeśli text
model może zwrócić tekst lub dowolną wymaganą wartość.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Musi być jednym z text elementów lub json_object . |
Nie. | text |
type Enum: AssistantsApiResponseFormat
Wartość | Opis |
---|---|
text | |
json_object |
Reprezentuje element assistant
, który może wywoływać model i używać narzędzi.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze assistant . |
Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia asystenta. | Tak | |
nazwa | string | Nazwa asystenta. Maksymalna długość to 256 znaków. |
Tak | |
opis | string | Opis asystenta. Maksymalna długość to 512 znaków. |
Tak | |
model | string | Identyfikator modelu do użycia. Interfejs API modeli list umożliwia wyświetlenie wszystkich dostępnych modeli lub zobacz nasze omówienie modelu, aby zapoznać się z ich opisami. |
Tak | |
instrukcje | string | Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków. |
Tak | |
tools | tablica | Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter , file_search lub function . |
Tak | [] |
tool_resources | obiekt | Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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 | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu "code_interpreter". Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Identyfikator magazynu wektorów dołączony do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
object Enum: AssistantObjectType
Wartość | Opis |
---|---|
asystent | Typ obiektu, który jest zawsze asystentem |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
model | Tak | |||
nazwa | string | Nazwa asystenta. Maksymalna długość to 256 znaków. |
Nie. | |
opis | string | Opis asystenta. Maksymalna długość to 512 znaków. |
Nie. | |
instrukcje | string | Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków. |
Nie. | |
tools | tablica | Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter , retrieval lub function . |
Nie. | [] |
tool_resources | obiekt | Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
|
vector_stores | tablica | Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
model | Nie. | |||
nazwa | string | Nazwa asystenta. Maksymalna długość to 256 znaków. |
Nie. | |
opis | string | Opis asystenta. Maksymalna długość to 512 znaków. |
Nie. | |
instrukcje | string | Instrukcje systemowe używane przez asystenta. Maksymalna długość to 32 768 znaków. |
Nie. | |
tools | tablica | Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter , retrieval lub function . |
Nie. | [] |
tool_resources | obiekt | Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Zastępuje listę identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Zastępuje magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Tak | ||
usunięta | boolean | Tak | ||
obiekt | string | Tak |
object Enum: DeleteAssistantResponseState
Wartość | Opis |
---|---|
assistant.deleted |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
dane | tablica | Tak | ||
first_id | string | Tak | ||
last_id | string | Tak | ||
has_more | boolean | Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Typ zdefiniowanego narzędzia: code_interpreter |
Tak |
type Enum: assistantToolsCodeType
Wartość | Opis |
---|---|
code_interpreter |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Typ zdefiniowanego narzędzia: file_search |
Tak | |
file_search | obiekt | Zastępuje narzędzie do wyszukiwania plików. | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
max_num_results | integer | 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. |
type Enum: assistantToolsFileSearchType
Wartość | Opis |
---|---|
file_search |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Typ zdefiniowanego narzędzia: file_search |
Tak |
type Enum: assistantToolsFileSearchType
Wartość | Opis |
---|---|
file_search |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Typ zdefiniowanego narzędzia: function |
Tak | |
function | obiekt | Definicja funkcji. | Tak |
Nazwa/nazwisko | Pisz | Opis | Domyślny |
---|---|---|---|
opis | string | Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
parameters | chatCompletionFunctionParameters | Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem, aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON, aby uzyskać dokumentację dotyczącą formatu. |
type Enum: assistantToolsFunction
Wartość | Opis |
---|---|
function |
Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | 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 auto wartości na wartość komunikaty w środku wątku zostaną porzucone w celu dopasowania do długości kontekstu modelu . max_prompt_tokens |
Tak | |
last_messages | integer | Liczba najnowszych komunikatów z wątku podczas konstruowania kontekstu przebiegu. | Nie. |
type Enum: TruncationType
Wartość | Opis |
---|---|
auto | |
last_messages |
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.
Ten składnik może być jednym z następujących elementów:
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Typ narzędzia. Jeśli typ to function , należy ustawić nazwę funkcji |
Tak | |
function | obiekt | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji do wywołania. |
type Enum: AssistantsNamedToolChoiceType
Wartość | Opis |
---|---|
function | |
code_interpreter | |
file_search |
Reprezentuje przebieg wykonywania w wątku.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze thread.run . |
Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia przebiegu. | Tak | |
thread_id | string | Identyfikator wątku, który został wykonany w ramach tego przebiegu. | Tak | |
assistant_id | string | Identyfikator asystenta używanego do wykonywania tego przebiegu. | Tak | |
stan | string | Stan przebiegu, który może mieć queued wartość , , in_progress , cancelled cancelling failed requires_action , completed lub .expired |
Tak | |
required_action | obiekt | Szczegółowe informacje na temat akcji wymaganej do kontynuowania przebiegu. Będzie to null , jeśli nie jest wymagana żadna akcja. |
Tak | |
last_error | obiekt | Ostatni błąd skojarzony z tym przebiegiem. Jeśli nie ma żadnych błędów, będzie występować null błąd. |
Tak | |
expires_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia przebiegu. | Tak | |
started_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu uruchomienia przebiegu. | Tak | |
cancelled_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania przebiegu. | Tak | |
failed_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla czasu niepowodzenia uruchomienia. | Tak | |
completed_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia przebiegu. | Tak | |
incomplete_details | obiekt | Szczegółowe informacje o tym, dlaczego przebieg jest niekompletny. Będzie to null , jeśli przebieg nie jest niekompletny. |
Tak | |
model | string | Model używany przez asystenta na potrzeby tego przebiegu. | Tak | |
instrukcje | string | Instrukcje używane przez asystenta do tego przebiegu. | Tak | |
tools | tablica | Lista narzędzi używanych przez asystenta do tego 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 | |
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 , queued itp.). |
Tak | |
temperature | Liczba | Temperatura próbkowania używana na potrzeby tego przebiegu. Jeśli nie zostanie ustawiona, wartość domyślna to 1. | Nie. | |
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. | |
max_prompt_tokens | integer | Maksymalna liczba tokenów monitów określonych do użycia w trakcie przebiegu. |
Tak | |
max_completion_tokens | integer | Maksymalna liczba tokenów ukończenia określonych do użycia w trakcie przebiegu. |
Tak | |
truncation_strategy | obcięcie obiektuObject | Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu. | Tak | |
tool_choice | assistantsApiToolChoiceOption | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.none oznacza, że model nie wywołuje żadnych narzędzi, a zamiast tego generuje komunikat.auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia.Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. |
Tak | |
parallel_tool_calls | ParallelToolCalls | Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia. | Nie. | Prawda |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
type | string | Na razie jest to zawsze submit_tool_outputs . |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
tool_calls | tablica | Lista odpowiednich wywołań narzędzi. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
code | string | Jeden z server_error lub rate_limit_exceeded . |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
wiadomość | string | Czytelny dla człowieka opis błędu. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
reason | string | Powód, dla którego przebieg jest niekompletny. Będzie to wskazywać, który limit tokenów został osiągnięty w trakcie przebiegu. |
object Enum: runObjectType
Wartość | Opis |
---|---|
thread.run | Typ obiektu przebiegu, który jest zawsze thread.run |
status Enum: RunObjectStatus
Wartość | Opis |
---|---|
Kolejce | Stan w kolejce |
in_progress | Stan in_progress |
requires_action | Stan required_action |
Anulowanie | Stan anulowania |
Anulowane | Stan anulowany |
niepowodzenie | Stan niepowodzenia |
zakończono | Stan ukończony |
Wygasłe | Stan wygasły |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
assistant_id | string | Identyfikator asystenta do wykonania tego przebiegu. | Tak | |
model | string | 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. | |
instrukcje | string | Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów. | Nie. | |
additional_instructions | string | 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. | |
additional_messages | tablica | Dodaje dodatkowe komunikaty do wątku przed utworzeniem przebiegu. | Nie. | |
tools | tablica | 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. | |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
strumień | boolean | Jeśli true program zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] . |
Nie. | |
max_prompt_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
max_completion_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
truncation_strategy | obcięcie obiektuObject | Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu. | Nie. | |
tool_choice | assistantsApiToolChoiceOption | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.none oznacza, że model nie wywołuje żadnych narzędzi, a zamiast tego generuje komunikat.auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia.Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. |
Nie. | |
parallel_tool_calls | ParallelToolCalls | Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia. | Nie. | Prawda |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
dane | tablica | Tak | ||
first_id | string | Tak | ||
last_id | string | Tak | ||
has_more | boolean | Tak |
Nazwisko | Pisz | Opis | Wymagani | 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. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
tool_outputs | tablica | Lista narzędzi, dla których są przesyłane dane wyjściowe. | Tak | |
strumień | boolean | Jeśli true program zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] . |
Nie. |
Obiekty wywołania narzędzi
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator wywołania narzędzia. Ten identyfikator musi być przywołyny podczas przesyłania danych wyjściowych narzędzia przy użyciu danych wyjściowych narzędzia Submit w celu uruchomienia punktu końcowego. | Tak | |
type | string | Typ narzędzia wywołującego dane wyjściowe jest wymagany. Na razie jest to zawsze function . |
Tak | |
function | obiekt | Definicja funkcji. | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Argumenty | string | Argumenty, które model oczekuje przekazania do funkcji. |
type Enum: RunToolCallObjectType
Wartość | Opis |
---|---|
function |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
assistant_id | string | Identyfikator asystenta do wykonania tego przebiegu. | Tak | |
wątek | createThreadRequest | Nie. | ||
model | string | 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. | |
instrukcje | string | Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów. | Nie. | |
tools | tablica | 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. | |
tool_resources | obiekt | Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. | |
temperature | 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ędzie bardziej skoncentrowany i deterministyczny. |
Nie. | 1 |
top_p | Liczba | Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z pierwszej masy prawdopodobieństwa o 10%. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu. |
Nie. | 1 |
strumień | boolean | Jeśli true program zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] . |
Nie. | |
stream_options | chatCompletionStreamOptions | Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true |
Nie. | Brak |
max_prompt_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
max_completion_tokens | integer | 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 . Zobacz incomplete_details , aby uzyskać więcej informacji. |
Nie. | |
truncation_strategy | obcięcie obiektuObject | Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu. | Nie. | |
tool_choice | assistantsApiToolChoiceOption | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.none oznacza, że model nie wywołuje żadnych narzędzi, a zamiast tego generuje komunikat.auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia.Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. |
Nie. | |
parallel_tool_calls | ParallelToolCalls | Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia. | Nie. | Prawda |
response_format | assistantsApiResponseFormatOption | Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106 .Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length" , co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Identyfikator magazynu wektorów dołączony do tego asystenta. Może istnieć maksymalnie jeden magazyn wektorów dołączony do asystenta. |
Reprezentuje wątek zawierający komunikaty.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze thread . |
Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia wątku. | Tak | |
tool_resources | obiekt | Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
Tak | |
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 |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Magazyn wektorów dołączony do tego wątku. Do wątku może być dołączony maksymalnie jeden magazyn wektorów. |
object Enum: ThreadObjectType
Wartość | Opis |
---|---|
wątek | Typ obiektu wątku, który jest zawsze thread |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
wiadomości | tablica | Lista komunikatów do uruchomienia wątku. | Nie. | |
tool_resources | obiekt | Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Magazyn wektorów dołączony do tego wątku. Do wątku może być dołączony maksymalnie jeden magazyn wektorów. |
|
vector_stores | tablica | Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego wątku. Do wątku może być dołączony maksymalnie jeden magazyn wektorów. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
tool_resources | obiekt | Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów. |
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. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_ids | tablica | Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem. |
[] |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
vector_store_ids | tablica | Magazyn wektorów dołączony do tego wątku. Do wątku może być dołączony maksymalnie jeden magazyn wektorów. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Tak | ||
usunięta | boolean | Tak | ||
obiekt | string | Tak |
object Enum: DeleteThreadResponseObjectState
Wartość | Opis |
---|---|
thread.deleted | Stan obiektu odpowiedzi usuwania wątku, który jest thread.deleted |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
dane | tablica | Tak | ||
first_id | string | Tak | ||
last_id | string | Tak | ||
has_more | boolean | Tak |
Reprezentuje komunikat w wątku.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze thread.message . |
Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia komunikatu. | Tak | |
thread_id | string | Identyfikator wątku, do którego należy ten komunikat. | Tak | |
stan | string | Stan komunikatu, który może mieć in_progress wartość , incomplete lub completed . |
Tak | |
incomplete_details | obiekt | W niekompletnej wiadomości szczegółowe informacje o tym, dlaczego wiadomość jest niekompletna. | Tak | |
completed_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu zakończenia komunikatu. | Tak | |
incomplete_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu, gdy komunikat został oznaczony jako niekompletny. | Tak | |
role | string | Jednostka, która wygenerowała komunikat. Jeden z user lub assistant . |
Tak | |
content | tablica | Zawartość wiadomości w tablicy tekstu i/lub obrazów. | Tak | |
assistant_id | string | Jeśli ma to zastosowanie, identyfikator asystenta, który napisał tę wiadomość. | Tak | |
run_id | string | Jeśli ma to zastosowanie, identyfikator przebiegu skojarzonego z tworzeniem tego komunikatu. | Tak | |
Załączniki | tablica | Lista plików dołączonych do wiadomości i narzędzi, do których zostały dodane. | 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 |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
reason | string | Przyczyna, dla którego komunikat jest niekompletny. |
object Enum: MessageObjectType
Wartość | Opis |
---|---|
thread.message | Typ obiektu komunikatu, który jest thread.message |
status Enum: MessageObjectStatus
Wartość | Opis |
---|---|
in_progress | |
Niekompletna | |
zakończono |
role Enum: MessageObjectRole
Wartość | Opis |
---|---|
Użytkownik | |
asystent |
Reprezentuje różnicę komunikatów, tj. wszystkie zmienione pola w wiadomości podczas przesyłania strumieniowego.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator komunikatu, do którego można się odwoływać w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze thread.message.delta . |
Tak | |
delta | obiekt | Delta zawierająca pola, które uległy zmianie w komunikacie. | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
role | string | Jednostka, która wygenerowała komunikat. Jeden z user lub assistant . |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
content | tablica | Zawartość wiadomości w tablicy tekstu i/lub obrazów. |
object Enum: MessageDeltaObjectType
Wartość | Opis |
---|---|
thread.message.delta |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
role | string | 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 | |
content | string | Zawartość wiadomości. | Tak | |
Załączniki | tablica | Lista plików dołączonych do wiadomości oraz narzędzia, do których należy je dodać. | 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. |
role Enum: CreateMessageRequestRole
Wartość | Opis |
---|---|
Użytkownik | |
asystent |
Nazwisko | Pisz | Opis | Wymagani | 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. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Tak | ||
usunięta | boolean | Tak | ||
obiekt | string | Tak |
object Enum: DeleteMessageResponseObject
Wartość | Opis |
---|---|
thread.message.deleted | Stan obiektu odpowiedzi komunikatu usuwania |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
dane | tablica | Tak | ||
first_id | string | Tak | ||
last_id | string | Tak | ||
has_more | boolean | Tak |
Odwołuje się do pliku obrazu w zawartości komunikatu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość image_file . |
Tak | |
image_file | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator pliku obrazu w zawartości wiadomości. |
type Enum: MessageContentImageFileObjectType
Wartość | Opis |
---|---|
image_file | Typ pliku obrazu zawartości wiadomości |
Zawartość tekstowa, która jest częścią wiadomości.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość text . |
Tak | |
text | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
wartość | string | Dane tworzące tekst. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Adnotacje | tablica |
type Enum: messageContentTextObjectType
Wartość | Opis |
---|---|
text | Typ obiektu zawartości wiadomoś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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość file_citation . |
Tak | |
text | string | Tekst w zawartości wiadomości, który musi zostać zastąpiony. | Tak | |
file_citation | obiekt | Tak | ||
start_index | integer | Tak | ||
end_index | integer | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator określonego pliku, z których pochodzi cytat. |
type Enum: FileCitationObjectType
Wartość | Opis |
---|---|
file_citation | Typ obiektu cytatu pliku |
Adres URL pliku, który jest generowany, gdy asystent użył code_interpreter
narzędzia do wygenerowania pliku.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość file_path . |
Tak | |
text | string | Tekst w zawartości wiadomości, który musi zostać zastąpiony. | Tak | |
file_path | obiekt | Tak | ||
start_index | integer | Tak | ||
end_index | integer | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator wygenerowanego pliku. |
type Enum: FilePathObjectType
Wartość | Opis |
---|---|
file_path | Typ obiektu ścieżki pliku |
Odwołuje się do pliku obrazu w zawartości komunikatu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks części zawartości w komunikacie. | Tak | |
type | string | Zawsze wartość image_file . |
Tak | |
image_file | obiekt | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator pliku obrazu w zawartości wiadomości. |
type Enum: MessageDeltaContentImageFileObjectType
Wartość | Opis |
---|---|
image_file |
Zawartość tekstowa, która jest częścią wiadomości.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks części zawartości w komunikacie. | Tak | |
type | string | Zawsze wartość text . |
Tak | |
text | obiekt | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
wartość | string | Dane tworzące tekst. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Adnotacje | tablica |
type Enum: MessageDeltaContentTextObjectType
Wartość | Opis |
---|---|
text |
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks adnotacji w części zawartości tekstowej. | Tak | |
type | string | Zawsze wartość file_citation . |
Tak | |
text | string | Tekst w zawartości wiadomości, który musi zostać zastąpiony. | Nie. | |
file_citation | obiekt | Nie. | ||
start_index | integer | Nie. | ||
end_index | integer | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator określonego pliku, z których pochodzi cytat. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
cytat | string | Konkretny cudzysłów w pliku. |
type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType
Wartość | Opis |
---|---|
file_citation |
Adres URL pliku, który jest generowany, gdy asystent użył code_interpreter
narzędzia do wygenerowania pliku.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks adnotacji w części zawartości tekstowej. | Tak | |
type | string | Zawsze wartość file_path . |
Tak | |
text | string | Tekst w zawartości wiadomości, który musi zostać zastąpiony. | Nie. | |
file_path | obiekt | Nie. | ||
start_index | integer | Nie. | ||
end_index | integer | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator wygenerowanego pliku. |
type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType
Wartość | Opis |
---|---|
file_path |
Reprezentuje krok wykonywania przebiegu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator kroku uruchamiania, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze assistant.run.step . |
Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia kroku uruchamiania. | Tak | |
assistant_id | string | Identyfikator asystenta skojarzonego z krokiem uruchamiania. | Tak | |
thread_id | string | Identyfikator uruchomionego wątku. | Tak | |
run_id | string | Identyfikator przebiegu, którego dotyczy ten krok przebiegu, jest częścią. | Tak | |
type | string | Typ kroku uruchamiania, który może mieć message_creation wartość lub tool_calls . |
Tak | |
stan | string | Stan przebiegu, który może mieć wartość in_progress , , cancelled failed , completed lub expired . |
Tak | |
step_details | runStepDetailsMessageCreationObject lub runStepDetailsToolCallsObject | Szczegóły kroku uruchamiania. | Tak | |
last_error | obiekt | Ostatni błąd skojarzony z tym krokiem przebiegu. Jeśli nie ma żadnych błędów, będzie występować null błąd. |
Tak | |
expired_at | integer | 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 | |
cancelled_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania kroku uruchamiania. | Tak | |
failed_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu niepowodzenia kroku uruchamiania. | Tak | |
completed_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia kroku uruchamiania. | 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 |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
code | string | Jeden z server_error lub rate_limit_exceeded . |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
wiadomość | string | Czytelny dla człowieka opis błędu. |
object Enum: RunStepObjectType
Wartość | Opis |
---|---|
assistant.run.step | Typ obiektu, który jest zawsze assistant.run.step |
type Enum: RunStepObjectType
Wartość | Opis |
---|---|
message_creation | Krok uruchamiania message_creation |
tool_calls | Krok uruchamiania tool_calls |
status Enum: RunStepObjectStatus
Wartość | Opis |
---|---|
in_progress | Stan uruchomienia in_progress |
Anulowane | Stan anulowanego uruchomienia |
niepowodzenie | Stan anulowanego uruchomienia |
zakończono | Stan anulowanego uruchomienia |
Wygasłe | Stan anulowanego uruchomienia |
Reprezentuje różnicę kroku uruchamiania, tj. wszelkie zmienione pola w kroku uruchamiania podczas przesyłania strumieniowego.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator kroku uruchamiania, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze thread.run.step.delta . |
Tak | |
delta | obiekt | Delta zawierająca pola, które zostały zmienione w kroku uruchamiania. | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
step_details | runStepDeltaStepDetailsMessageCreationObject lub runStepDeltaStepDetailsToolCallsObject | Szczegóły kroku uruchamiania. |
object Enum: RunStepDeltaObjectType
Wartość | Opis |
---|---|
thread.run.step.delta |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
dane | tablica | Tak | ||
first_id | string | Tak | ||
last_id | string | Tak | ||
has_more | boolean | Tak |
Szczegółowe informacje o tworzeniu komunikatu w kroku uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość message_creation . |
Tak | |
message_creation | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
message_id | string | Identyfikator komunikatu, który został utworzony przez ten krok przebiegu. |
type Enum: RunStepDetailsMessageCreationObjectType
Wartość | Opis |
---|---|
message_creation |
Szczegółowe informacje o tworzeniu komunikatu w kroku uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość message_creation . |
Tak | |
message_creation | obiekt | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
message_id | string | Identyfikator komunikatu, który został utworzony przez ten krok przebiegu. |
type Enum: RunStepDeltaStepDetailsMessageCreationObjectType
Wartość | Opis |
---|---|
message_creation |
Szczegóły wywołania narzędzia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość tool_calls . |
Tak | |
tool_calls | tablica | 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 |
type Enum: RunStepDetailsToolCallsObjectType
Wartość | Opis |
---|---|
tool_calls |
Szczegóły wywołania narzędzia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość tool_calls . |
Tak | |
tool_calls | tablica | 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. |
type Enum: RunStepDeltaStepDetailsToolCallsObjectType
Wartość | Opis |
---|---|
tool_calls |
Szczegóły narzędzia interpretera kodu, w ramach którego był zaangażowany krok uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator wywołania narzędzia. | Tak | |
type | string | Typ wywołania narzędzia. To zawsze będzie code_interpreter dotyczyć tego typu wywołania narzędzia. |
Tak | |
code_interpreter | obiekt | Definicja wywołania narzędzia Interpreter kodu. | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
dane_wejściowe | string | Dane wejściowe wywołania narzędzia Interpreter kodu. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Wyjść | tablica | 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. |
type Enum: RunStepDetailsToolCallsCodeObjectType
Wartość | Opis |
---|---|
code_interpreter |
Szczegóły narzędzia interpretera kodu, w ramach którego był zaangażowany krok uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks wywołania narzędzia w narzędziu wywołuje tablicę. | Tak | |
identyfikator | string | Identyfikator wywołania narzędzia. | Nie. | |
type | string | Typ wywołania narzędzia. To zawsze będzie code_interpreter dotyczyć tego typu wywołania narzędzia. |
Tak | |
code_interpreter | obiekt | Definicja wywołania narzędzia Interpreter kodu. | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
dane_wejściowe | string | Dane wejściowe wywołania narzędzia Interpreter kodu. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Wyjść | tablica | 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. |
type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType
Wartość | Opis |
---|---|
code_interpreter |
Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu w ramach kroku uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość logs . |
Tak | |
dzienniki | string | Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu. | Tak |
type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType
Wartość | Opis |
---|---|
dzienniki |
Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu w ramach kroku uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks danych wyjściowych w tablicy danych wyjściowych. | Tak | |
type | string | Zawsze wartość logs . |
Tak | |
dzienniki | string | Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu. | Nie. |
type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType
Wartość | Opis |
---|---|
dzienniki |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość image . |
Tak | |
obraz | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator pliku obrazu. |
type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType
Wartość | Opis |
---|---|
obraz |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks danych wyjściowych w tablicy danych wyjściowych. | Tak | |
type | string | Zawsze wartość image . |
Tak | |
obraz | obiekt | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
file_id | string | Identyfikator pliku obrazu. |
type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject
Wartość | Opis |
---|---|
obraz |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator obiektu wywołania narzędzia. | Tak | |
type | string | Typ wywołania narzędzia. To zawsze będzie file_search dotyczyć tego typu wywołania narzędzia. |
Tak | |
file_search | obiekt | Na razie zawsze będzie to pusty obiekt. | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Wyniki | tablica | Wyniki wyszukiwania plików. |
type Enum: RunStepDetailsToolCallsFileSearchObjectType
Wartość | Opis |
---|---|
file_search |
Wystąpienie wyników wyszukiwania plików.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
file_id | string | Identyfikator pliku, w ramach którego znaleziono wynik. | Tak | |
file_name | string | Nazwa pliku, w ramach którego znaleziono wynik. | Tak | |
score | Liczba | Wynik. Wszystkie wartości muszą być liczbą zmiennoprzecinkową z zakresu od 0 do 1. | Tak | |
content | tablica | Zawartość znalezionego wyniku. Zawartość jest dołączana tylko w przypadku żądania za pośrednictwem parametru include zapytania. | Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks wywołania narzędzia w narzędziu wywołuje tablicę. | Tak | |
identyfikator | string | Identyfikator obiektu wywołania narzędzia. | Nie. | |
type | string | Typ wywołania narzędzia. To zawsze będzie retrieval dotyczyć tego typu wywołania narzędzia. |
Tak | |
file_search | obiekt | Na razie zawsze będzie to pusty obiekt. | Tak |
type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType
Wartość | Opis |
---|---|
file_search |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator obiektu wywołania narzędzia. | Tak | |
type | string | Typ wywołania narzędzia. To zawsze będzie function dotyczyć tego typu wywołania narzędzia. |
Tak | |
function | obiekt | Definicja funkcji, która została wywołana. | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Argumenty | string | Argumenty przekazane do funkcji. |
Nazwa/nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
output | string | Dane wyjściowe funkcji. Będzie to miało wartość null , jeśli dane wyjściowe nie zostały jeszcze przesłane. |
type Enum: RunStepDetailsToolCallsFunctionObjectType
Wartość | Opis |
---|---|
function |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
index | integer | Indeks wywołania narzędzia w narzędziu wywołuje tablicę. | Tak | |
identyfikator | string | Identyfikator obiektu wywołania narzędzia. | Nie. | |
type | string | Typ wywołania narzędzia. To zawsze będzie function dotyczyć tego typu wywołania narzędzia. |
Tak | |
function | obiekt | Definicja funkcji, która została wywołana. | Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
nazwa | string | Nazwa funkcji. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Argumenty | string | Argumenty przekazane do funkcji. |
Nazwa/nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
output | string | Dane wyjściowe funkcji. Będzie to miało wartość null , jeśli dane wyjściowe nie zostały jeszcze przesłane. |
type Enum: RunStepDetailsToolCallsFunctionObjectType
Wartość | Opis |
---|---|
function |
Zasady wygasania magazynu wektorów.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
kotwica | string | Znacznik czasu zakotwiczenia, po którym mają zastosowanie zasady wygasania. Obsługiwane kotwice: last_active_at . |
Tak | |
dni | integer | Liczba dni po upływie czasu zakotwiczenia, przez który magazyn wektorów wygaśnie. | Tak |
anchor Enum: VectorStoreExpirationAfterAnchor
Wartość | Opis |
---|---|
last_active_at | Znacznik czasu zakotwiczenia, po którym mają zastosowanie zasady wygasania. |
Magazyn wektorów to kolekcja przetworzonych plików może być używana przez file_search
narzędzie.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | wyliczenie | Typ obiektu, który jest zawsze vector_store .Możliwe wartości: vector_store |
Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia magazynu wektorów. | Tak | |
nazwa | string | Nazwa magazynu wektorów. | Tak | |
usage_bytes | integer | Całkowita liczba bajtów używanych przez pliki w magazynie wektorów. | Tak | |
file_counts | obiekt | Tak | ||
stan | string | Stan magazynu wektorów, który może mieć expired wartość , in_progress lub completed . Stan completed wskazuje, że magazyn wektorów jest gotowy do użycia. |
Tak | |
expires_after | vectorStoreExpirationAfter | Zasady wygasania magazynu wektorów. | Nie. | |
expires_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia magazynu wektorów. | Nie. | |
last_active_at | integer | 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 |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
in_progress | integer | Liczba obecnie przetwarzanych plików. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
zakończono | integer | Liczba plików, które zostały pomyślnie przetworzone. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
niepowodzenie | integer | Liczba plików, które nie mogły przetworzyć. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Anulowane | integer | Liczba anulowanych plików. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
total | integer | Całkowita liczba plików. |
status Enum: VectorStoreObjectStatus
Wartość | Opis |
---|---|
Wygasłe | |
in_progress | |
zakończono |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
file_ids | tablica | 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. | |
nazwa | string | Nazwa magazynu wektorów. | Nie. | |
expires_after | vectorStoreExpirationAfter | Zasady wygasania magazynu wektorów. | Nie. | |
chunking_strategy | autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam | Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. Dotyczy tylko wtedy, gdy file_ids nie ma żadnychmpty. |
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. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
nazwa | string | Nazwa magazynu wektorów. | Nie. | |
expires_after | 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. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
dane | tablica | Tak | ||
first_id | string | Tak | ||
last_id | string | Tak | ||
has_more | boolean | Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Tak | ||
usunięta | boolean | Tak | ||
obiekt | string | Tak |
object Enum: DeleteVectorStoreResponseObject
Wartość | Opis |
---|---|
vector_store.deleted | Stan obiektu odpowiedzi magazynu wektorów usuwania |
Lista plików dołączonych do magazynu wektorów.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze vector_store.file . |
Tak | |
usage_bytes | integer | Łączne użycie magazynu wektorów w bajtach. Należy pamiętać, że może się to różnić od oryginalnego rozmiaru pliku. | Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia pliku magazynu wektorów. | Tak | |
vector_store_id | string | Identyfikator magazynu wektorów, do którego jest dołączony plik. | Tak | |
stan | string | Stan pliku magazynu wektorów, który może mieć in_progress wartość , , completed cancelled lub failed . Stan completed wskazuje, że plik magazynu wektorów jest gotowy do użycia. |
Tak | |
last_error | obiekt | Ostatni błąd skojarzony z tym plikiem magazynu wektorów. Jeśli nie ma żadnych błędów, będzie występować null błąd. |
Tak | |
chunking_strategy | autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam | Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. Dotyczy tylko wtedy, gdy file_ids nie ma żadnychmpty. |
Nie. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
code | string | Jeden z server_error lub lub unsupported_file invalid_file . |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
wiadomość | string | Czytelny dla człowieka opis błędu. |
object Enum: VectorStoreFileObjectType
Wartość | Opis |
---|---|
vector_store.file |
status Enum: VectorStoreFileObjectStatus
Wartość | Opis |
---|---|
in_progress | |
zakończono | |
Anulowane | |
niepowodzenie |
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.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość other . |
Tak |
type Enum: OtherChunkingStrategyResponseParamType
Wartość | Opis |
---|---|
other |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | string | Zawsze wartość static . |
Tak | |
static | staticChunkingStrategy | Tak |
type Enum: StaticChunkingStrategyResponseParamType
Wartość | Opis |
---|---|
static |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
max_chunk_size_tokens | integer | Maksymalna liczba tokenów w każdym kawałku. Domyślna wartość to 800 . Wartość minimalna to 100 , a wartość maksymalna to 4,096 . |
Tak | |
chunk_overlap_tokens | integer | Liczba tokenów nakładających się między fragmentami. Domyślna wartość to 400 .Należy pamiętać, że nakładanie się nie może przekraczać połowy wartości max_chunk_size_tokens . |
Tak |
Strategia domyślna. Ta strategia używa obecnie wartości max_chunk_size_tokens
800
i chunk_overlap_tokens
.400
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Zawsze wartość auto .Możliwe wartości: auto |
Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
type | wyliczenie | Zawsze wartość static .Możliwe wartości: statyczne |
Tak | |
static | staticChunkingStrategy | Tak |
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:
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
file_id | string | 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 | |
chunking_strategy | fragmentingStrategyRequestParam | Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. |
Nie. |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
obiekt | string | Tak | ||
dane | tablica | Tak | ||
first_id | string | Tak | ||
last_id | string | Tak | ||
has_more | boolean | Tak |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Tak | ||
usunięta | boolean | Tak | ||
obiekt | string | Tak |
object Enum: DeleteVectorStoreFileResponseObject
Wartość | Opis |
---|---|
vector_store.file.deleted |
Partia plików dołączonych do magazynu wektorów.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
identyfikator | string | Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. | Tak | |
obiekt | string | Typ obiektu, który jest zawsze vector_store.file_batch . |
Tak | |
created_at | integer | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia partii plików magazynu wektorów. | Tak | |
vector_store_id | string | Identyfikator magazynu wektorów, do którego jest dołączony plik. | Tak | |
stan | string | Stan partii plików magazynu wektorów, który może mieć in_progress wartość , completed cancelled lub failed . |
Tak | |
file_counts | obiekt | Tak |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
in_progress | integer | Liczba obecnie przetwarzanych plików. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
zakończono | integer | Liczba przetworzonych plików. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
niepowodzenie | integer | Liczba plików, które nie mogły przetworzyć. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
Anulowane | integer | Liczba anulowanych plików. |
Nazwisko | Pisz | Opis | Wartość domyślna |
---|---|---|---|
total | integer | Całkowita liczba plików. |
object Enum: VectorStoreFileBatchObjectType
Wartość | Opis |
---|---|
vector_store.files_batch |
status Enum: VectorStoreFileBatchObjectStatus
Wartość | Opis |
---|---|
in_progress | |
zakończono | |
Anulowane | |
niepowodzenie |
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
file_ids | tablica | 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 | |
chunking_strategy | fragmentingStrategyRequestParam | Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. |
Nie. |
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 event
zdarzenie , 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:
Ten składnik może być jednym z następujących elementów:
Występuje po utworzeniu nowego wątku.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | threadObject | Reprezentuje wątek zawierający komunikaty. | Tak |
Dane: threadObject
Wyliczenie zdarzeń: ThreadStreamEventEnum
Wartość | Opis |
---|---|
thread.created | Zdarzenie utworzone przez wątek |
Ten składnik może być jednym z następujących elementów:
Występuje po utworzeniu nowego przebiegu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventCreated
Wartość | Opis |
---|---|
thread.run.created |
Występuje, gdy przebieg przechodzi do queued
stanu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventQueued
Wartość | Opis |
---|---|
thread.run.queued |
Występuje, gdy przebieg przechodzi do in_progress
stanu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventInProgress
Wartość | Opis |
---|---|
thread.run.in_progress |
Występuje, gdy przebieg przechodzi do requires_action
stanu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventRequiresAction
Wartość | Opis |
---|---|
thread.run.requires_action |
Występuje po zakończeniu przebiegu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventCompleted
Wartość | Opis |
---|---|
thread.run.completed |
Występuje, gdy uruchomienie zakończy się niepowodzeniem.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventFailed
Wartość | Opis |
---|---|
thread.run.failed |
Występuje, gdy przebieg przechodzi do cancelling
stanu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventCancelling
Wartość | Opis |
---|---|
thread.run.cancelling |
Występuje po anulowaniu przebiegu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventCancelled
Wartość | Opis |
---|---|
thread.run.cancelled |
Występuje po wygaśnięciu przebiegu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runObject | Reprezentuje przebieg wykonywania w wątku. | Tak |
Dane: runObject
Wyliczenie zdarzeń: RunStreamEventExpired
Wartość | Opis |
---|---|
thread.run.expired |
Ten składnik może być jednym z następujących elementów:
Występuje po utworzeniu kroku uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runStepObject | Reprezentuje krok wykonywania przebiegu. |
Tak |
Dane: runStepObject
Wyliczenie zdarzeń: RunStepStreamEventCreated
Wartość | Opis |
---|---|
thread.run.step.created |
Występuje, gdy krok uruchomienia przechodzi do in_progress
stanu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runStepObject | Reprezentuje krok wykonywania przebiegu. |
Tak |
Dane: runStepObject
Wyliczenie zdarzeń: RunStepStreamEventInProgress
Wartość | Opis |
---|---|
thread.run.step.in_progress |
Występuje, gdy są przesyłane strumieniowo części kroku uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runStepDeltaObject | Reprezentuje różnicę kroku uruchamiania, tj. wszelkie zmienione pola w kroku uruchamiania podczas przesyłania strumieniowego. |
Tak |
Dane: runStepDeltaObject
Wyliczenie zdarzeń: RunStepStreamEventDelta
Wartość | Opis |
---|---|
thread.run.step.delta |
Występuje po zakończeniu kroku uruchamiania.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runStepObject | Reprezentuje krok wykonywania przebiegu. |
Tak |
Dane: runStepObject
Wyliczenie zdarzeń: RunStepStreamEventCompleted
Wartość | Opis |
---|---|
thread.run.step.completed |
Występuje, gdy krok uruchomienia zakończy się niepowodzeniem.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runStepObject | Reprezentuje krok wykonywania przebiegu. |
Tak |
Dane: runStepObject
Wyliczenie zdarzenia: RunStepStreamEventFailed
Wartość | Opis |
---|---|
thread.run.step.failed |
Występuje, gdy krok uruchomienia zostanie anulowany.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runStepObject | Reprezentuje krok wykonywania przebiegu. |
Tak |
Dane: runStepObject
Wyliczenie zdarzeń: RunStepStreamEventCancelled
Wartość | Opis |
---|---|
thread.run.step.cancelled |
Występuje, gdy krok uruchomienia wygaśnie.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | runStepObject | Reprezentuje krok wykonywania przebiegu. |
Tak |
Dane: runStepObject
Wyliczenie zdarzeń: RunStepStreamEventExpired
Wartość | Opis |
---|---|
thread.run.step.expired |
Ten składnik może być jednym z następujących elementów:
Występuje po utworzeniu komunikatu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | messageObject | Reprezentuje komunikat w wątku. | Tak |
Dane: messageObject
Wyliczenie zdarzeń: MessageStreamEventCreated
Wartość | Opis |
---|---|
thread.message.created |
Występuje, gdy komunikat przechodzi do in_progress
stanu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | messageObject | Reprezentuje komunikat w wątku. | Tak |
Dane: messageObject
Wyliczenie zdarzeń: MessageStreamEventInProgress
Wartość | Opis |
---|---|
thread.message.in_progress |
Występuje, gdy są przesyłane strumieniowo części komunikatu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | messageDeltaObject | Reprezentuje różnicę komunikatów, tj. wszystkie zmienione pola w wiadomości podczas przesyłania strumieniowego. |
Tak |
Dane: messageDeltaObject
Wyliczenie zdarzeń: MessageStreamEventDelta
Wartość | Opis |
---|---|
thread.message.delta |
Występuje po zakończeniu komunikatu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | messageObject | Reprezentuje komunikat w wątku. | Tak |
Dane: messageObject
Wyliczenie zdarzeń: MessageStreamEventCompleted
Wartość | Opis |
---|---|
thread.message.completed |
Występuje, gdy komunikat kończy się przed jego ukończeniem.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | messageObject | Reprezentuje komunikat w wątku. | Tak |
Dane: messageObject
Wyliczenie zdarzeń: MessageStreamEventIncomplete
Wartość | Opis |
---|---|
thread.message.incomplete |
Występuje, gdy wystąpi błąd. Może się to zdarzyć z powodu wewnętrznego błędu serwera lub przekroczenia limitu czasu.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | błąd | Tak |
event Enum: ErrorEventEnum
Wartość | Opis |
---|---|
error |
Występuje po zakończeniu strumienia.
Nazwisko | Pisz | Opis | Wymagani | Wartość domyślna |
---|---|---|---|---|
event | string | Tak | ||
dane | string | Tak |
event Enum: DoneEventEnum
Wartość | Opis |
---|---|
Gotowe |
data Enum: DoneEventDataEnum
Wartość | Opis |
---|---|
[GOTOWE] |
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.
Szkolenie
Moduł
Dowiedz się, jak używać zestawu .NET SDK z usługą Azure OpenAI, aby aplikacje prowadziły rozmowy z użytkownikami w języku naturalnym.