Nuta
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować się zalogować lub zmienić katalog.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Uwaga / Notatka
Ten dokument odnosi się do portalu Microsoft Foundry (klasycznego).
🔍 Zapoznaj się z dokumentacją rozwiązania Microsoft Foundry (nową), aby dowiedzieć się więcej o nowym portalu.
Ten artykuł zawiera szczegółowe informacje na temat punktów końcowych interfejsu API REST wnioskowania dla usługi Azure OpenAI.
Specyfikacje interfejsu API
Zarządzanie modelami i zasobami Azure OpenAI oraz interakcja z nimi są podzielone na trzy podstawowe elementy interfejsu API.
- Płaszczyzna sterowania
- Płaszczyzna danych — tworzenie
- Płaszczyzna danych — wnioskowanie
Każda powierzchnia/specyfikacja interfejsu API hermetyzuje inny zestaw funkcji usługi Azure OpenAI. Każdy interfejs API ma swój własny unikatowy zestaw wersji zapoznawczych i stabilne/ogólnie dostępne wersje interfejsu API. Obecnie wersje zapoznawcze zwykle podążają za miesięcznym harmonogramem.
Ważne
Teraz dostępny jest nowy interfejs API do wnioskowania w wersji zapoznawczej. Dowiedz się więcej w naszym przewodniku cyklu życia interfejsu API.
| API | Najnowsza wersja zapoznawcza | Najnowsza wersja ogólnie dostępna | Specyfikacje | Opis |
|---|---|---|---|---|
| Płaszczyzna sterowania | 2025-07-01-preview |
2025-06-01 |
Pliki specyfikacji | Interfejs API płaszczyzny sterowania służy do wykonywania operacji, takich jak tworzenie zasobów, wdrażanie modelu i inne zadania zarządzania zasobami wyższego poziomu. Płaszczyzna sterowania decyduje również o możliwościach wykorzystania takich narzędzi, jak Azure Resource Manager, Bicep, Terraform i Azure CLI. |
| Płaszczyzna danych | v1 preview |
v1 |
Pliki specyfikacji | Interfejs API płaszczyzny danych kontroluje operacje wnioskowania i tworzenia. |
Uwierzytelnianie
Usługa Azure OpenAI udostępnia dwie metody uwierzytelniania. Możesz użyć kluczy interfejsu API lub Microsoft Entra ID.
Uwierzytelnianie klucza interfejsu API: w przypadku tego typu uwierzytelniania wszystkie żądania interfejsu API muszą zawierać klucz interfejsu API w nagłówku
api-keyHTTP. 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 elementemBearer, na przykładBearer YOUR_AUTH_TOKEN. Możesz przeczytać nasz przewodnik z instrukcjami dotyczącymi uwierzytelniania za pomocą identyfikatora Entra firmy Microsoft.
Przechowywanie wersji interfejsu API REST
Interfejsy API usługi są wersjonowane za pomocą parametru api-version zapytania. Wszystkie wersje są zgodne ze strukturą dat RRRR-MM-DD. Przykład:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
Tworzenie płaszczyzny danych
W pozostałej części artykułu omówiono wersję zapoznawczą specyfikacji wnioskowania płaszczyzny danych platformy Azure OpenAI. 2025-04-01-preview
Jeśli szukasz dokumentacji najnowszej wersji interfejsu API ga, zapoznaj się z najnowszym interfejsem API wnioskowania płaszczyzny danych ogólnie dostępnego
Batch — lista
GET {endpoint}/openai/batches?api-version=2025-04-01-preview
Pobiera listę wszystkich partii należących do zasobu usługi Azure OpenAI.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego zdarzenia z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba partii do pobrania. Wartość domyślna to 20. |
| $filter | kwerenda | Nie. | ciąg | Wyrażenie OData opisujące warunki filtrowania. |
| $orderby | kwerenda | Nie. | ciąg | Wyrażenie OData do opisania kolejności sortowania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | BatchesList |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/batches?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"has_more": false,
"data": [
{
"object": "batch",
"id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
"endpoint": "/chat/completions",
"errors": null,
"input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
"completion_window": "24h",
"status": "completed",
"output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
"error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
"created_at": 1646126127,
"in_progress_at": 1646126130,
"expires_at": 1646126170,
"finalizing_at": 1646126134,
"completed_at": 1646126136,
"failed_at": null,
"expired_at": null,
"cancelling_at": null,
"cancelled_at": null,
"request_counts": {
"total": 500,
"completed": 400,
"failed": 100
},
"first_id": "batch_abc123",
"last_id": "batch_abc456",
"metadata": {
"batch_description": "Evaluation job"
}
}
],
"object": "list"
}
}
Batch — Tworzenie
POST {endpoint}/openai/batches?api-version=2025-04-01-preview
Tworzy i wykonuje partię z przekazanego pliku żądań.
Odpowiedź zawiera szczegóły zadania w kolejce, w tym stan zadania.
Identyfikator pliku wyników jest dodawany do odpowiedzi po zakończeniu.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: aplikacja/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| okno ukończenia | ciąg | Przedział czasu, w którym należy przetworzyć partię. | Tak | |
| punkt końcowy | ciąg | Punkt końcowy interfejsu API używany przez partię. | Tak | |
| input_blob | ciąg | Adres URL obiektu blob usługi Azure Storage do użycia jako dane wejściowe dla zadania przetwarzania wsadowego. | Nie. | |
| identyfikator_pliku_wejściowego | ciąg | Identyfikator pliku wejściowego dla partii. | Nie. | |
| metadane | obiekt | Zestaw par klucz-wartość, które można dołączyć do zadania. Może to być przydatne do przechowywania dodatkowych informacji o partii w formacie ustrukturyzowanym. | Nie. | |
| wynik_wygasa_po | PlikExpiresAfter | Definiuje wygaśnięcie pliku. | Nie. | |
| folder_wyjściowy | BatchOutputReference | Folder usługi Azure Storage do przechowywania danych wyjściowych. | Nie. |
Odpowiedzi
Kod stanu: 201
Opis: Partia została pomyślnie utworzona.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Partia |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/batches?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 201
{
"headers": {
"deployment-enqueued-tokens": 1000,
"deployment-maximum-enqueued-tokens": 5000
},
"body": {
"object": "batch",
"id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
"endpoint": "/chat/completions",
"errors": null,
"input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
"completion_window": "24h",
"status": "validating",
"output_file_id": null,
"error_file_id": null,
"created_at": 1646126127,
"in_progress_at": null,
"expires_at": null,
"finalizing_at": null,
"completed_at": null,
"failed_at": null,
"expired_at": null,
"cancelling_at": null,
"cancelled_at": null,
"request_counts": {
"total": 0,
"completed": 0,
"failed": 0
},
"metadata": {
"batch_description": "Evaluation job"
}
}
}
Batch — pobierz
GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview
Pobiera szczegóły dla pojedynczej partii określonej przez dany identyfikator partii.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator partii | ścieżka | Tak | ciąg | Identyfikator partii. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Partia |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "batch",
"id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
"endpoint": "/chat/completions",
"errors": null,
"input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
"completion_window": "24h",
"status": "completed",
"output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
"error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
"created_at": 1646126127,
"in_progress_at": 1646126130,
"expires_at": 1646126170,
"finalizing_at": 1646126134,
"completed_at": 1646126136,
"failed_at": null,
"expired_at": null,
"cancelling_at": null,
"cancelled_at": null,
"request_counts": {
"total": 500,
"completed": 400,
"failed": 100
},
"metadata": {
"batch_description": "Evaluation job"
}
}
}
Partia — Anuluj
POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview
Anuluje przetwarzanie partii określonej przez dany identyfikator partii.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator partii | ścieżka | Tak | ciąg | Identyfikator partii. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Partia została pomyślnie anulowana.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Partia |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "batch",
"id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
"endpoint": "/chat/completions",
"errors": null,
"input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
"completion_window": "24h",
"status": "cancelling",
"output_file_id": null,
"error_file_id": null,
"created_at": 1646126127,
"in_progress_at": 1646126130,
"expires_at": 1646126170,
"finalizing_at": null,
"completed_at": null,
"failed_at": null,
"expired_at": null,
"cancelling_at": 1646126138,
"cancelled_at": null,
"request_counts": {
"total": 500,
"completed": 100,
"failed": 5
},
"metadata": {
"batch_description": "Evaluation job"
}
}
}
Przechowywane uzupełnienia — lista
GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview
Pobiera listę przechowywanych uzupełnień.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| metadane | kwerenda | Nie. | ciąg | Filtruj według pary (klucz, wartość) w przechowywanym uzupełnianiu. |
| model | kwerenda | Nie. | ciąg | Filtruj według nazwy modelu. |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego przechowywanego ukończenia z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba przechowywanych uzupełnień do pobrania. Wartość domyślna to 20. |
| porządek | kwerenda | Nie. | ciąg | Kolejność wyników według czasu utworzenia (rosnąco lub malejąco). Wartość domyślna to desc. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | ListaUkończonychElementów |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "list",
"data": [
{
"id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"model": "gpt-4o-mini-2024-07-18",
"created": 1738193475,
"request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
"usage": {
"total_tokens": 25,
"completion_tokens": 7,
"prompt_tokens": 18
},
"seed": 123,
"top_p": 1,
"temperature": 1,
"presence_penalty": 0,
"frequency_penalty": 0,
"system_fingerprint": "fp_f3927aa00d",
"metadata": {
"key_1": "val_1",
"key_2": "val_2"
},
"choices": [
{
"index": 0,
"message": {
"content": "Hello, how are you?",
"role": "assistant"
},
"finish_reason": "stop"
}
]
}
],
"total": 1,
"first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"has_more": false
}
}
Zapisane ukończenie - Pobierz
GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Pobiera uzupełnianie przez podany przechowywany identyfikator ukończenia.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| id-zakończonego-przechowywania | ścieżka | Tak | ciąg | Identyfikator przechowywanego uzupełniania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | StoredCompletionResponse |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "chat.completion",
"id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"model": "gpt-4o-mini-2024-07-18",
"created": 1738193475,
"request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
"usage": {
"total_tokens": 25,
"completion_tokens": 7,
"prompt_tokens": 18
},
"seed": 123,
"top_p": 1,
"temperature": 1,
"presence_penalty": 0,
"frequency_penalty": 0,
"system_fingerprint": "fp_f3927aa00d",
"metadata": {
"key_1": "val_1",
"key_2": "val_2"
},
"choices": [
{
"index": 0,
"message": {
"content": "Hello, how are you?",
"role": "assistant"
},
"finish_reason": "stop"
}
]
}
}
Uzupełnianie przechowywane — aktualizacja
POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Zaktualizuj przechowywane uzupełnianie według podanego przechowywanego identyfikatora ukończenia.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| id-zakończonego-przechowywania | ścieżka | Tak | ciąg | Identyfikator przechowywanego uzupełniania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: aplikacja/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| metadane | obiekt | Aby uzyskać dodatkowe informacje, należy uzyskać dowolne pary klucz-wartość. | Nie. |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | ZapisanaKompletacja |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "chat.completion",
"id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"model": "gpt-4o-mini-2024-07-18",
"created": 1738193475,
"request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
"usage": {
"total_tokens": 25,
"completion_tokens": 7,
"prompt_tokens": 18
},
"seed": 123,
"top_p": 1,
"temperature": 1,
"presence_penalty": 0,
"frequency_penalty": 0,
"system_fingerprint": "fp_f3927aa00d",
"metadata": {
"key_1": "val_1",
"key_2": "val_2"
},
"choices": [
{
"index": 0,
"message": {
"content": "Hello, how are you?",
"role": "assistant"
},
"finish_reason": "stop"
}
]
}
}
Uzupełnianie przechowywane — usuwanie
DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Usuń przechowywane uzupełnianie według podanego przechowywanego identyfikatora ukończenia.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| id-zakończonego-przechowywania | ścieżka | Tak | ciąg | Identyfikator przechowywanego uzupełniania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Pomyślnie usunięto przechowywane zakończenie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | StoredCompletionDelete |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "chat.completion.deleted",
"id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"deleted": true
}
}
Uzupełnianie przechowywane — Getmessages
GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview
Pobiera przechowywane komunikaty uzupełniania według podanego przechowywanego identyfikatora ukończenia.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| id-zakończonego-przechowywania | ścieżka | Tak | ciąg | Identyfikator przechowywanego uzupełniania. |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego przechowywanego komunikatu ukończenia z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba przechowywanych komunikatów ukończenia do pobrania. Wartość domyślna to 20. |
| porządek | kwerenda | Nie. | ciąg | Kolejność wyników według indeksu komunikatów (rosnąco lub malejąco). Wartość domyślna to asc. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | PrzechowywaneWiadomościUkończenia |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "list",
"data": [
{
"role": "user",
"content": "Hello"
}
],
"total": 1,
"first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"has_more": false
}
}
Ewaluacja — pobierz listę
GET {endpoint}/openai/evals?api-version=2025-04-01-preview
Wymień oceny dla projektu.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniej oceny z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba ocen do pobrania. |
| porządek | kwerenda | Nie. | ciąg Możliwe wartości: asc, desc |
Kolejność sortowania ocen według znacznika czasu. Użyj asc dla kolejności rosnącej lub desc dla kolejności malejącej. |
| sortuj_według | kwerenda | Nie. | ciąg Możliwe wartości: created_at, updated_at |
Oceny mogą być uporządkowane według czasu utworzenia lub czasu ostatniej aktualizacji. Użyj created_at dla czasu utworzenia lub updated_at dla czasu ostatniej aktualizacji. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Lista ocen
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | EvalList |
Przykłady
GET {endpoint}/openai/evals?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "list",
"data": [
{
"object": "eval",
"id": "eval_6801694950848190b10968bb628b651d",
"data_source_config": {
"type": "custom",
"schema": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"A": {
"type": "string"
},
"B": {
"type": "string"
},
"C": {
"type": "string"
},
"D": {
"type": "string"
},
"answer": {
"type": "string"
}
}
}
},
"required": [
"item"
]
}
},
"testing_criteria": [
{
"name": "string check",
"type": "string_check",
"input": "{{sample.output_text}}",
"reference": "{{item.answer}}",
"operation": "eq"
}
],
"name": "Math Quiz",
"created_at": 1744922953,
"metadata": {}
}
],
"first_id": "eval_6801694950848190b10968bb628b651d",
"last_id": "eval_6801694950848190b10968bb628b651d",
"has_more": false
}
}
Utworzyć ocenę
POST {endpoint}/openai/evals?api-version=2025-04-01-preview
Utwórz strukturę oceny, która może służyć do testowania wydajności modelu. Ocena to zestaw kryteriów testowania i źródła danych. Po utworzeniu oceny można uruchomić go na różnych modelach i parametrach modelu. Obsługujemy kilka typów klasyrów i źródeł danych.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 201
Opis: OK
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Eval |
Przykłady
POST {endpoint}/openai/evals?api-version=2025-04-01-preview
{
"name": "Math Quiz",
"data_source_config": {
"type": "custom",
"include_sample_schema": true,
"item_schema": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"A": {
"type": "string"
},
"B": {
"type": "string"
},
"C": {
"type": "string"
},
"D": {
"type": "string"
},
"answer": {
"type": "string"
}
}
}
},
"testing_criteria": [
{
"type": "string_check",
"reference": "{{item.answer}}",
"input": "{{sample.output_text}}",
"operation": "eq",
"name": "string check"
}
]
}
Odpowiedzi: Kod stanu: 201
{
"headers": {},
"body": {
"object": "eval",
"id": "eval_6801694950848190b10968bb628b651d",
"data_source_config": {
"type": "custom",
"schema": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"A": {
"type": "string"
},
"B": {
"type": "string"
},
"C": {
"type": "string"
},
"D": {
"type": "string"
},
"answer": {
"type": "string"
}
}
}
},
"required": [
"item"
]
}
},
"testing_criteria": [
{
"name": "string check",
"type": "string_check",
"input": "{{sample.output_text}}",
"reference": "{{item.answer}}",
"operation": "eq"
}
],
"name": "Math Quiz",
"created_at": 1744922953,
"metadata": {}
}
}
Ocena — usuwanie
DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Usuń ocenę.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny do usunięcia. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Ocena została pomyślnie usunięta.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | obiekt |
Kod stanu: 404
Opis: Nie można odnaleźć oceny.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Błąd |
Przykłady
DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "eval.deleted",
"deleted": true,
"eval_id": "eval_6801694950848190b10968bb628b651d"
}
}
Kod stanu: 404
{
"headers": {},
"body": {
"code": "notFound",
"message": "Evaluation with ID eval_6801694950848190b10968bb628b651d not found."
}
}
Ocena — uzyskaj
GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Uzyskaj ocenę na podstawie identyfikatora.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny do odzyskania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Ocena
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Eval |
Przykłady
GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "eval",
"id": "eval_6801694950848190b10968bb628b651d",
"data_source_config": {
"type": "custom",
"schema": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"A": {
"type": "string"
},
"B": {
"type": "string"
},
"C": {
"type": "string"
},
"D": {
"type": "string"
},
"answer": {
"type": "string"
}
}
}
},
"required": [
"item"
]
}
},
"testing_criteria": [
{
"name": "string check",
"type": "string_check",
"input": "{{sample.output_text}}",
"reference": "{{item.answer}}",
"operation": "eq"
}
],
"name": "Math Quiz",
"created_at": 1744922953,
"metadata": {}
}
}
Ocena — aktualizacja
POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Zaktualizuj niektóre właściwości oceny.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny do zaktualizowania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: zaktualizowana ocena
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Eval |
Przykłady
POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
{
"name": "Updated Math Quiz",
"metadata": {
"description": "Updated description"
}
}
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "eval",
"id": "eval_6801694950848190b10968bb628b651d",
"data_source_config": {
"type": "custom",
"schema": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"A": {
"type": "string"
},
"B": {
"type": "string"
},
"C": {
"type": "string"
},
"D": {
"type": "string"
},
"answer": {
"type": "string"
}
}
}
},
"required": [
"item"
]
}
},
"testing_criteria": [
{
"name": "string check",
"type": "string_check",
"input": "{{sample.output_text}}",
"reference": "{{item.answer}}",
"operation": "eq"
}
],
"name": "Updated Math Quiz",
"created_at": 1744922953,
"metadata": {
"description": "Updated description"
}
}
}
Ocena – Getrunlist
GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview
Pobierz listę przebiegów oceny.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny, dla której mają zostać pobrane przebiegi. |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego uruchomienia z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba przebiegów do pobrania. |
| porządek | kwerenda | Nie. | ciąg Możliwe wartości: asc, desc |
Kolejność sortowania przebiegów według znacznika czasu. Użyj asc dla kolejności rosnącej lub desc dla kolejności malejącej. Wartość domyślna to asc. |
| stan | kwerenda | Nie. | ciąg Możliwe wartości: queued, , in_progresscompleted, , canceledfailed |
Filtruj uruchomienia według stanu. Użyj poleceń "queued" (oczekujące), "in_progress" (w toku), "failed" (nieudane), "completed" (zakończone), "canceled" (anulowane). |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Lista przebiegów oceny
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | EvalRunList |
Przykłady
GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "list",
"data": [
{
"object": "eval.run",
"id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"eval_id": "eval_6801694950848190b10968bb628b651d",
"report_url": "https://ai.azure.com/resource/evaluation",
"status": "queued",
"model": "gpt-4o-mini",
"name": "Math quiz",
"created_at": 1744923141,
"result_counts": {
"total": 0,
"errored": 0,
"failed": 0,
"passed": 0
},
"per_model_usage": null,
"per_testing_criteria_results": null,
"data_source": {
"type": "completions",
"source": {
"type": "file_content",
"content": [
{
"item": {
"question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
"A": "0",
"B": "4",
"C": "2",
"D": "6",
"answer": "B"
}
},
{
"item": {
"question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
"A": "8",
"B": "2",
"C": "24",
"D": "120",
"answer": "C"
}
}
]
},
"input_messages": {
"template": [
{
"type": "message",
"role": "system",
"content": {
"text": "Answer the question's with A, B, C, or D."
}
},
{
"type": "message",
"role": "user",
"content": {
"text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
}
}
]
},
"model": "gpt-4o-mini",
"sampling_params": {
"seed": 42,
"temperature": 1,
"top_p": 1
}
},
"error": null,
"metadata": {}
}
],
"first_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"last_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"has_more": false
}
}
Ocena — tworzenie przebiegu
POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview
Utwórz nowy proces oceny. Jest to punkt końcowy, który rozpocznie klasyfikację.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny potrzebny do utworzenia przebiegu. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 201
Opis: Pomyślnie utworzono przebieg oceny
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | EvalRun |
Kod stanu: 400
Opis: Nieprawidłowe żądanie (na przykład brak obiektu eval)
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Błąd |
Przykłady
POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview
{
"name": "Math quiz",
"data_source": {
"type": "completions",
"source": {
"type": "file_content",
"content": [
{
"item": {
"question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
"A": "0",
"B": "4",
"C": "2",
"D": "6",
"answer": "B"
}
},
{
"item": {
"question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
"A": "8",
"B": "2",
"C": "24",
"D": "120",
"answer": "C"
}
}
]
},
"input_messages": {
"type": "template",
"template": [
{
"type": "message",
"role": "system",
"content": {
"text": "Answer the question's with A, B, C, or D."
}
},
{
"type": "message",
"role": "user",
"content": {
"text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
}
}
]
},
"model": "gpt-4o-mini",
"sampling_params": {
"temperature": 1,
"top_p": 1,
"seed": 42
}
}
}
Odpowiedzi: Kod stanu: 201
{
"headers": {},
"body": {
"object": "eval.run",
"id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"eval_id": "eval_6801694950848190b10968bb628b651d",
"report_url": "https://ai.azure.com/resource/evaluation",
"status": "queued",
"model": "gpt-4o-mini",
"name": "Math quiz",
"created_at": 1744923141,
"result_counts": {
"total": 0,
"errored": 0,
"failed": 0,
"passed": 0
},
"per_model_usage": null,
"per_testing_criteria_results": null,
"data_source": {
"type": "completions",
"source": {
"type": "file_content",
"content": [
{
"item": {
"question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
"A": "0",
"B": "4",
"C": "2",
"D": "6",
"answer": "B"
}
},
{
"item": {
"question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
"A": "8",
"B": "2",
"C": "24",
"D": "120",
"answer": "C"
}
}
]
},
"input_messages": {
"type": "template",
"template": [
{
"type": "message",
"role": "system",
"content": {
"text": "Answer the question's with A, B, C, or D."
}
},
{
"type": "message",
"role": "user",
"content": {
"text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
}
}
]
},
"model": "gpt-4o-mini",
"sampling_params": {
"seed": 42,
"temperature": 1,
"top_p": 1
}
},
"error": null,
"metadata": {}
}
}
Ocena — usuwanie uruchomienia
DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Usuń przebieg oceny.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny, z której ma zostać usunięty przebieg. |
| identyfikator uruchomienia | ścieżka | Tak | ciąg | Identyfikator przebiegu do usunięcia. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Pomyślnie usunięto przebieg oceny
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | obiekt |
Kod stanu: 404
Opis: Nie można odnaleźć przebiegu
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Błąd |
Przykłady
DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "eval.deleted",
"deleted": true,
"run_id": "evalrun_68016a056f0481909b9774447bdd1aa3"
}
}
Kod stanu: 404
{
"headers": {},
"body": {
"code": "notFound",
"message": "Evaluation Run with ID evalrun_68016a056f0481909b9774447bdd1aa3 not found."
}
}
Ocena — uruchomienie
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Pobierz ocenę na podstawie identyfikatora.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny, dla której mają zostać pobrane przebiegi. |
| identyfikator uruchomienia | ścieżka | Tak | ciąg | Identyfikator przebiegu do pobrania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Przebieg oceny
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | EvalRun |
Przykłady
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "eval.run",
"id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"eval_id": "eval_6801694950848190b10968bb628b651d",
"report_url": "https://ai.azure.com/resource/evaluation",
"status": "queued",
"model": "gpt-4o-mini",
"name": "Math quiz",
"created_at": 1744923141,
"result_counts": {
"total": 0,
"errored": 0,
"failed": 0,
"passed": 0
},
"per_model_usage": null,
"per_testing_criteria_results": null,
"data_source": {
"type": "completions",
"source": {
"type": "file_content",
"content": [
{
"item": {
"question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
"A": "0",
"B": "4",
"C": "2",
"D": "6",
"answer": "B"
}
},
{
"item": {
"question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
"A": "8",
"B": "2",
"C": "24",
"D": "120",
"answer": "C"
}
}
]
},
"input_messages": {
"type": "template",
"template": [
{
"type": "message",
"role": "system",
"content": {
"text": "Answer the question's with A, B, C, or D."
}
},
{
"type": "message",
"role": "user",
"content": {
"text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
}
}
]
},
"model": "gpt-4o-mini",
"sampling_params": {
"seed": 42,
"temperature": 1,
"top_p": 1
}
},
"error": null,
"metadata": {}
}
}
Ocena - Anuluj uruchomienie
POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Anulowanie trwającego przebiegu oceny.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator ewaluacji, której wykonanie chcesz anulować. |
| identyfikator uruchomienia | ścieżka | Tak | ciąg | Identyfikator uruchomienia do anulowania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: anulowany obiekt przebiegu ewaluacji
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | EvalRun |
Przykłady
POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "eval.run",
"id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"eval_id": "eval_6801694950848190b10968bb628b651d",
"report_url": "https://ai.azure.com/resource/evaluation",
"status": "canceled",
"model": "gpt-4o-mini",
"name": "Math quiz",
"created_at": 1744923141,
"result_counts": {
"total": 0,
"errored": 0,
"failed": 0,
"passed": 0
},
"per_model_usage": null,
"per_testing_criteria_results": null,
"data_source": {
"type": "completions",
"source": {
"type": "file_content",
"content": [
{
"item": {
"question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
"A": "0",
"B": "4",
"C": "2",
"D": "6",
"answer": "B"
}
},
{
"item": {
"question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
"A": "8",
"B": "2",
"C": "24",
"D": "120",
"answer": "C"
}
}
]
},
"input_messages": {
"type": "template",
"template": [
{
"type": "message",
"role": "system",
"content": {
"text": "Answer the question's with A, B, C, or D."
}
},
{
"type": "message",
"role": "user",
"content": {
"text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
}
}
]
},
"model": "gpt-4o-mini",
"sampling_params": {
"seed": 42,
"temperature": 1,
"top_p": 1
}
},
"error": null,
"metadata": {}
}
}
Ocena — Getrunoutputitems
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview
Pobierz listę elementów wyjściowych dla przebiegu oceny.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny, dla której mają zostać pobrane przebiegi. |
| identyfikator uruchomienia | ścieżka | Tak | ciąg | Identyfikator przebiegu w celu pobrania elementów wyjściowych. |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego elementu wyjściowego z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba elementów wyjściowych do pobrania. |
| stan | kwerenda | Nie. | ciąg Możliwe wartości: fail, pass |
Filtruj elementy wyjściowe według stanu. Użyj failed do filtrowania według nieudanych elementów wyjściowych lub pass do filtrowania według przekazanych elementów wyjściowych. |
| porządek | kwerenda | Nie. | ciąg Możliwe wartości: asc, desc |
Kolejność sortowania elementów wyjściowych według znacznika czasu. Użyj asc dla kolejności rosnącej lub desc dla kolejności malejącej. Wartość domyślna to asc. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Lista elementów wyjściowych przebiegu oceny
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | EvalRunOutputItemList |
Przykłady
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "list",
"data": [
{
"object": "eval.run.output_item",
"id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
"created_at": 1744925265,
"run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"eval_id": "eval_6801694950848190b10968bb628b651d",
"status": "fail",
"datasource_item_id": 1,
"datasource_item": {
"question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
"A": "8",
"B": "2",
"C": "24",
"D": "120",
"answer": "C"
},
"results": [
{
"name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
"sample": null,
"passed": false,
"score": 0
}
],
"sample": {
"input": [
{
"role": "system",
"content": "Answer the question's with A, B, C, or D.",
"function_call": null
},
{
"role": "user",
"content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120.",
"function_call": null
}
],
"output": [
{
"role": "assistant",
"content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. ",
"function_call": null
}
],
"finish_reason": "stop",
"model": "gpt-4o-mini-2024-07-18",
"usage": {
"total_tokens": 627,
"completion_tokens": 546,
"prompt_tokens": 81,
"cached_tokens": 0
},
"error": null,
"temperature": 1,
"top_p": 1,
"seed": 42
}
},
{
"object": "eval.run.output_item",
"id": "outputitem_6801724f54888190942ec66a197309dd",
"created_at": 1744925263,
"run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"eval_id": "eval_6801694950848190b10968bb628b651d",
"status": "fail",
"datasource_item_id": 0,
"datasource_item": {
"question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
"A": "0",
"B": "4",
"C": "2",
"D": "6",
"answer": "B"
},
"results": [
{
"name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
"sample": null,
"passed": false,
"score": 0
}
],
"sample": {
"input": [
{
"role": "system",
"content": "Answer the question's with A, B, C, or D.",
"function_call": null
},
{
"role": "user",
"content": "Question: Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q. A: 0 B: 4 C: 2 D: 6.",
"function_call": null
}
],
"output": [
{
"role": "assistant",
"content": "To find the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\), we can simplify \\(\\sqrt{18}\\) since \\(\\sqrt{18} = \\sqrt{9 \\cdot 2} = 3\\sqrt{2}\\). \n\nThus, the field can be rewritten as \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\).\n\nNext, we calculate the degree of the extensions step by step:\n\n1. The extension \\(\\mathbb{Q}(\\sqrt{2})\\) over \\(\\mathbb{Q}\\) has degree 2, since \\(\\sqrt{2}\\) is not in \\(\\mathbb{Q}\\) and satisfies the polynomial \\(x^2 - 2\\).\n\n2. Next, we consider the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\). The element \\(\\sqrt{3}\\) is also not in \\(\\mathbb{Q}(\\sqrt{2})\\) and satisfies the polynomial \\(x^2 - 3\\), which is irreducible over \\(\\mathbb{Q}(\\sqrt{2})\\). Hence, the degree of the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\) is also 2.\n\nNow we can combine these degrees:\n\n\\[\n[\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}] = [\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}(\\sqrt{2})] \\times [\\mathbb{Q}(\\sqrt{2}) : \\mathbb{Q}] = 2 \\times 2 = 4.\n\\]\n\nThus, the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\) is 4.\n\nTherefore, the answer is:\n\n**B: 4**.",
"function_call": null
}
],
"finish_reason": "stop",
"model": "gpt-4o-mini-2024-07-18",
"usage": {
"total_tokens": 556,
"completion_tokens": 487,
"prompt_tokens": 69,
"cached_tokens": 0
},
"error": null,
"temperature": 1,
"top_p": 1,
"seed": 42
}
}
],
"first_id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
"last_id": "outputitem_6801724f54888190942ec66a197309dd",
"has_more": false
}
}
Ocena — Getrunoutputitem
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview
Pobierz element wyjściowy przebiegu oceny według identyfikatora.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| eval-id | ścieżka | Tak | ciąg | Identyfikator oceny, dla której mają zostać pobrane przebiegi. |
| identyfikator uruchomienia | ścieżka | Tak | ciąg | Identyfikator przebiegu do pobrania. |
| identyfikator-elementu-wyjściowego | ścieżka | Tak | ciąg | Identyfikator elementu wyjściowego do pobrania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: element wyjściowy przebiegu oceny
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | EvalRunOutputItem |
Przykłady
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "eval.run.output_item",
"id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
"created_at": 1744925265,
"run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
"eval_id": "eval_6801694950848190b10968bb628b651d",
"status": "fail",
"datasource_item_id": 1,
"datasource_item": {
"question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
"A": "8",
"B": "2",
"C": "24",
"D": "120",
"answer": "C"
},
"results": [
{
"name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
"sample": null,
"passed": false,
"score": 0
}
],
"sample": {
"input": [
{
"role": "system",
"content": "Answer the question's with A, B, C, or D."
},
{
"role": "user",
"content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120."
}
],
"output": [
{
"role": "assistant",
"content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. "
}
],
"finish_reason": "stop",
"model": "gpt-4o-mini-2024-07-18",
"usage": {
"total_tokens": 627,
"completion_tokens": 546,
"prompt_tokens": 81,
"cached_tokens": 0
},
"error": null,
"temperature": 1,
"top_p": 1,
"seed": 42
}
}
}
Pliki — lista
GET {endpoint}/openai/files?api-version=2025-04-01-preview
Pobiera listę wszystkich plików należących do zasobu usługi Azure OpenAI.
Należą do nich zawartość przekazana przez użytkownika, taka jak pliki z celem "precyzyjne dostrajanie" na potrzeby trenowania lub walidacji modeli dostrajania, a także plików generowanych przez usługę, takich jak "precyzyjne dostrajanie wyników", które zawierają różne metryki odpowiedniego zadania dostrajania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| cel | kwerenda | Nie. | ciąg Możliwe wartości: fine-tune, , fine-tune-resultsassistants, assistants_outputbatch, , batch_output, , evalsevals_output |
Zwracaj tylko pliki z danym celem. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 10 000, a wartość domyślna to 10 000. |
after |
kwerenda | Nie. | ciąg | Kursor do użycia w stronicowaniu.
after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy. |
| porządek | kwerenda | Nie. | ciąg | Kolejność sortowania według znacznika czasu created_at obiektów.
asc w przypadku kolejności rosnącej i desc kolejności malejącej. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Lista plików |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/files?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"data": [
{
"status": "processed",
"bytes": 140,
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
},
{
"status": "processed",
"bytes": 32423,
"purpose": "fine-tune-results",
"filename": "results.csv",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
}
],
"object": "list"
}
}
Pliki: wysyłanie
POST {endpoint}/openai/files?api-version=2025-04-01-preview
Tworzy nową jednostkę pliku, przekazując dane z komputera lokalnego. Przekazane pliki mogą na przykład służyć do trenowania lub oceniania dostrajanych modeli.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: dane wielu części/formularzu
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| kotwica | ciąg | Definiuje kotwicę względem czasu wygenerowania bezwzględnego wygaśnięcia. | Nie. | |
| Sekund | liczba całkowita | Pobiera względny czas wygaśnięcia w sekundach. | ||
| Zakres: [1209600 – 2592000]. | Nie. | |||
| plik | ciąg | Pobiera lub ustawia plik do przekazania do usługi Azure OpenAI. | Tak | |
| cel | ciąg | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
Odpowiedzi
Kod stanu: 201
Opis: Plik został pomyślnie utworzony.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Plik |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/files?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 201
{
"headers": {
"location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
},
"body": {
"status": "pending",
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
}
}
Pliki — importowanie
POST {endpoint}/openai/files/import?api-version=2025-04-01-preview
Tworzy nową jednostkę pliku, importując dane z podanego adresu URL. Przekazane pliki mogą na przykład służyć do trenowania lub oceniania dostrajanych modeli.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: aplikacja/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| content_url | ciąg | Adres URL do pobrania dokumentu z witryny (może to być adres URL sygnatury dostępu współdzielonego obiektu blob lub dowolny inny zewnętrzny adres URL dostępny za pomocą żądania GET). | Tak | |
| wygasa po | PlikExpiresAfter | Definiuje wygaśnięcie pliku. | Nie. | |
| nazwa pliku | ciąg | Nazwa pliku JSON Lines , który ma zostać przekazany. | ||
Jeśli purpose jest ustawiona na "dostrojenie", każdy wiersz jest rekordem JSON z polami "prompt" i "completion" reprezentującymi przykłady trenowania. |
Tak | |||
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
Odpowiedzi
Kod stanu: 201
Opis: Plik został pomyślnie utworzony.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Plik |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/files/import?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 201
{
"headers": {
"location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
},
"body": {
"status": "pending",
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
}
}
Pliki — pobieranie
GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Pobiera szczegóły dla pojedynczego pliku określonego przez dany identyfikator pliku, w tym stan, rozmiar, cel itp.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator pliku | ścieżka | Tak | ciąg | Identyfikator pliku. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Plik |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"status": "processed",
"bytes": 140,
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
}
}
Pliki — usuwanie
DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Usuwa plik z danym identyfikatorem pliku.
Usunięcie jest również dozwolone, jeśli plik został użyty, np. jako plik treningowy w zadaniu dostrajania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator pliku | ścieżka | Tak | ciąg | Identyfikator pliku. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Plik został pomyślnie usunięty.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | PlikUsuń |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"object": "file",
"deleted": true,
"id": "file-181a1cbdcdcf4677ada87f63a0928099"
}
}
Pliki — pobieranie zawartości
GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview
Pobiera zawartość pliku określonego przez dany identyfikator pliku.
Pliki mogą być przekazywane przez użytkownika lub tworzone przez usługę, na przykład metryki wyników procesu dostrajania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator pliku | ścieżka | Tak | ciąg | Identyfikator pliku. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/octet-stream | ciąg | |
| aplikacja/json | ciąg |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/octet-stream | Odpowiedź na błąd | |
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": "raw file content"
}
Dostrajanie — lista
GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Pobiera listę wszystkich zadań dostrajania szczegółowego należących do zasobu usługi Azure OpenAI. Szczegóły zwracane dla każdego zadania dostrajania zawierają, oprócz jego identyfikatora, podstawowy model, pliki trenowania i walidacji, hiperparametry, sygnatury czasowe, status i zdarzenia.
Zdarzenia są tworzone po zmianie stanu zadania. Na przykład uruchomienie lub ukończenie i przekazanie wyników.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego zdarzenia z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba zdarzeń do pobrania. Wartość domyślna to 20. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | ListaZadańFineTuning |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"has_more": false,
"data": [
{
"hyperparameters": {
"n_epochs": -1
},
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "custom-wandb-project",
"tags": [
"project:tag",
"lineage"
]
}
}
],
"method": {
"type": "supervised"
},
"status": "succeeded",
"model": "curie",
"fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
"result_files": [
"file-181a1cbdcdcf4677ada87f63a0928099"
],
"finished_at": 1646127311,
"trained_tokens": 2342,
"id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "fine_tuning.job"
}
],
"object": "list"
}
}
Dostrajanie — tworzenie
POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Tworzy zadanie, które dostraja określony model z danego pliku szkoleniowego.
Odpowiedź zawiera szczegóły zadania w kolejce, w tym stan zadania i parametry hyper.
Nazwa dostrojonego modelu jest dodawana do odpowiedzi po zakończeniu.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: aplikacja/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| hiperparametry | FineTuningHyperParameters | Ustawienia parametrów hyper używane w zadaniu dostrajania. | Nie. | |
| Integracje | macierz | Lista konfiguracji integracji obsługujących zadanie dostrajania. Zaplanowano wiele integracji, dlatego upewnij się, że sprawdzasz typ integracji i działasz na nim. | Nie. | |
| metoda | obiekt | Metoda używana do nadzorowanego dostrajania | Nie. | |
| └typ | FineTuningMethodType | Nie. | ||
| model | ciąg | Identyfikator (model-id) modelu podstawowego używanego na potrzeby tej precyzyjnej melodii. | Tak | |
| nasienie | liczba całkowita | Nasiono używane do działania dostrajania. Przekazywanie tych samych parametrów nasion i zadania powinno generować te same wyniki, ale mogą się różnić w rzadkich przypadkach. Jeśli nasion nie zostanie określony, zostanie wygenerowany dla Ciebie. | Nie. | |
| przyrostek | ciąg | Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9, - i _), które zostaną dodane do dostosowanej nazwy modelu. | Nie. | |
| plik szkoleniowy | ciąg | Tożsamość pliku (identyfikator pliku), która jest używana do trenowania tego dobrze dostosowanego modelu. | Tak | |
| plik walidacji | ciąg | Tożsamość pliku (identyfikator pliku), która jest używana do oceny dobrze dostosowanego modelu podczas trenowania. | Nie. |
Odpowiedzi
Kod stanu: 201
Opis: Pomyślnie utworzono dopasowanie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | FineTuningJob |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 201
{
"headers": {
"location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f"
},
"body": {
"hyperparameters": {
"n_epochs": -1
},
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "custom-wandb-project",
"tags": [
"project:tag",
"lineage"
]
}
}
],
"method": {
"type": "supervised"
},
"status": "pending",
"model": "curie",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
"id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "fine_tuning.job"
}
}
Dostrajanie — pobierz
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Pobiera szczegóły dla pojedynczego zadania dostrajania określonego przez dany identyfikator fine-tune-id.
Szczegóły zawierają podstawowy model, pliki trenowania i walidacji, hiperparaparatki, sygnatury czasowe, stan i zdarzenia.
Zdarzenia są tworzone po zmianie stanu zadania, np. uruchomieniu lub zakończeniu, oraz po przekazaniu wyników.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator zadania dostrajania | ścieżka | Tak | ciąg | Identyfikator zadania dostrajania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | FineTuningJob |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"hyperparameters": {
"n_epochs": -1
},
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "custom-wandb-project",
"tags": [
"project:tag",
"lineage"
]
}
}
],
"method": {
"type": "supervised"
},
"status": "succeeded",
"model": "curie",
"fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
"result_files": [
"file-181a1cbdcdcf4677ada87f63a0928099"
],
"finished_at": 1646127311,
"trained_tokens": 2342,
"id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "fine_tuning.job"
}
}
Dostrajanie — usuwanie
DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Usuwa zadanie dostrajania określone przez dany identyfikator fine-tune-id.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator zadania dostrajania | ścieżka | Tak | ciąg | Identyfikator zadania dostrajania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 204
Opis: Pomyślnie usunięto dostosowanie.
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 204
{
"headers": {}
}
Dostrajanie — anulowanie
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview
Anuluje przetwarzanie zadania dostrajania określonego przez podany identyfikator „fine-tune-id”.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator zadania dostrajania | ścieżka | Tak | ciąg | Identyfikator zadania dostrajania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Pomyślnie anulowano dostrojenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | FineTuningJob |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"hyperparameters": {
"n_epochs": -1
},
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "custom-wandb-project",
"tags": [
"project:tag",
"lineage"
]
}
}
],
"method": {
"type": "supervised"
},
"status": "cancelled",
"model": "curie",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
"finished_at": 1646127311,
"id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "fine_tuning.job"
}
}
Dostrajanie — uzyskiwanie punktów kontrolnych
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview
Pobiera punkty kontrolne dla zadania dostrajania określonego przez dany identyfikator fine-tune-id.
Punkty kontrolne są tworzone na końcu udanych etapów podczas trenowania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator zadania dostrajania | ścieżka | Tak | ciąg | Identyfikator zadania dostrajania. |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego identyfikatora punktu kontrolnego z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba punktów kontrolnych do pobrania. Wartość domyślna to 10. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Lista punktów kontrolnych dla zadania dostrajania |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"has_more": false,
"data": [
{
"id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P",
"created_at": 1646126127,
"fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10",
"step_number": 10,
"metrics": {
"step": 10,
"train_loss": 0.478,
"train_mean_token_accuracy": 0.924,
"valid_loss": 10.112,
"valid_mean_token_accuracy": 0.145,
"full_valid_loss": 0.567,
"full_valid_mean_token_accuracy": 0.944
},
"fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
"object": "fine_tuning.job.checkpoint"
},
{
"id": "ftckpt_frtXDR2453C4FG67t03MLPs5",
"created_at": 1646126137,
"fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20",
"step_number": 20,
"metrics": {
"step": 20,
"train_loss": 0.355,
"train_mean_token_accuracy": 0.947,
"valid_loss": 11.32,
"valid_mean_token_accuracy": 0.122,
"full_valid_loss": 0.317,
"full_valid_mean_token_accuracy": 0.955
},
"fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
"object": "fine_tuning.job.checkpoint"
},
{
"id": "ftckpt_agLk6Gio560ORp14gl123fgd",
"created_at": 1646126147,
"fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30",
"step_number": 30,
"metrics": {
"step": 30,
"train_loss": 0.155,
"train_mean_token_accuracy": 0.975,
"valid_loss": 9.31,
"valid_mean_token_accuracy": 0.092,
"full_valid_loss": 0.114,
"full_valid_mean_token_accuracy": 0.963
},
"fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
"object": "fine_tuning.job.checkpoint"
}
],
"object": "list"
}
}
Dostrajanie — pobieranie zdarzeń
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview
Pobiera zdarzenia dla zadania dostrajania zadanego przez podany identyfikator fine-tune-id.
Zdarzenia są tworzone po zmianie stanu zadania, np. uruchomieniu lub zakończeniu, oraz po przekazaniu wyników.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator zadania dostrajania | ścieżka | Tak | ciąg | Identyfikator zadania dostrajania. |
| po | kwerenda | Nie. | ciąg | Identyfikator ostatniego zdarzenia z poprzedniego żądania stronicowania. |
| limit / ograniczenie | kwerenda | Nie. | liczba całkowita | Liczba zdarzeń do pobrania. Wartość domyślna to 20. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | FineTuningJobEventList |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"has_more": false,
"data": [
{
"id": "ftevent-363dcd7cb4c74539bc53293c1dceef05",
"created_at": 1646126127,
"level": "info",
"message": "Job enqueued. Waiting for jobs ahead to complete.",
"type": "message",
"object": "fine_tuning.job.event"
},
{
"id": "ftevent-8c2a44999790437cb3230e543fa2cf0f",
"created_at": 1646126169,
"level": "info",
"message": "Job started.",
"type": "message",
"object": "fine_tuning.job.event"
},
{
"id": "ftevent-2d47d651d2f3484c8187c88c00078147",
"created_at": 1646126192,
"level": "info",
"message": "Job succeeded.",
"type": "message",
"object": "fine_tuning.job.event"
}
],
"object": "list"
}
}
Dostrajanie — wstrzymywanie
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview
Wstrzymanie przetwarzania zadania dostrajania określonego przez podany identyfikator dostrajania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator zadania dostrajania | ścieżka | Tak | ciąg | Identyfikator zadania dostrajania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Dobra melodia została pomyślnie wstrzymana.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | FineTuningJob |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"hyperparameters": {
"n_epochs": -1
},
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "custom-wandb-project",
"tags": [
"project:tag",
"lineage"
]
}
}
],
"method": {
"type": "supervised"
},
"status": "paused",
"model": "curie",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
"finished_at": 1646127311,
"id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "fine_tuning.job"
}
}
Dostrajanie — Wznów
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview
Wznawia przetwarzanie zadania dostrajania określonego przez dany identyfikator dostrajania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator zadania dostrajania | ścieżka | Tak | ciąg | Identyfikator zadania dostrajania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Dobra melodia została pomyślnie wznowiona.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | FineTuningJob |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"hyperparameters": {
"n_epochs": -1
},
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "custom-wandb-project",
"tags": [
"project:tag",
"lineage"
]
}
}
],
"method": {
"type": "supervised"
},
"status": "resuming",
"model": "curie",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
"finished_at": 1646127311,
"id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "fine_tuning.job"
}
}
Zadania pozyskiwania — lista
GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview
Wyświetla listę zadań pozyskiwania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
| token-użytkownika-mgmt | nagłówek | Nie. | ciąg | Token używany do uzyskiwania dostępu do obszaru roboczego (wymagany tylko w przypadku zadań obliczeniowych użytkownika). |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | IngestionJobList |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"value": [
{
"jobId": "usercompute-ingestion-job",
"kind": "UserCompute",
"workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
},
{
"jobId": "syscompute-ingestion-job",
"kind": "SystemCompute"
}
]
}
}
Zadania pozyskiwania — tworzenie
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Tworzy zadanie pozyskiwania o określonym identyfikatorze zadania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
| identyfikator zadania | ścieżka | Tak | ciąg | Identyfikator zadania, które zostanie utworzone. |
| token-użytkownika-mgmt | nagłówek | Nie. | ciąg | Token używany do uzyskiwania dostępu do obszaru roboczego (wymagany tylko w przypadku zadań obliczeniowych użytkownika). |
| token użytkownika AML | nagłówek | Nie. | ciąg | Token używany do uzyskiwania dostępu do zasobów w ramach zadania w obszarze roboczym (wymagany tylko w przypadku zadań obliczeniowych użytkownika). |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: aplikacja/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| ID zadania | ciąg | Nie. | ||
| rodzaj | IngestionJobType | Typ zadania. | Tak |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | IngestionJob |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {
"operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
},
"body": {
"kind": "SystemCompute",
"jobId": "ingestion-job",
"searchServiceConnection": {
"kind": "EndpointWithManagedIdentity",
"endpoint": "https://aykame-dev-search.search.windows.net"
},
"datasource": {
"kind": "Storage",
"connection": {
"kind": "EndpointWithManagedIdentity",
"endpoint": "https://mystorage.blob.core.windows.net/",
"resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
},
"containerName": "container",
"chunking": {
"maxChunkSizeInTokens": 2048
},
"embeddings": [
{
"connection": {
"kind": "RelativeConnection"
},
"deploymentName": "Ada"
}
]
},
"dataRefreshIntervalInHours": 24,
"completionAction": "keepAllAssets"
}
}
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {
"operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
},
"body": {
"kind": "UserCompute",
"jobId": "ingestion-job",
"workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
"compute": {
"kind": "ServerlessCompute"
},
"target": {
"kind": "AzureAISearch",
"connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
},
"datasource": {
"kind": "Dataset",
"datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
"datasetType": "uri_folder"
}
}
}
Zadania przetwarzania danych — Odzyskiwanie
GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Pobiera szczegóły określonego identyfikatora zadania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
| identyfikator zadania | ścieżka | Tak | ciąg | Identyfikator zadania. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | IngestionJob |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"kind": "UserCompute",
"jobId": "ingestion-job",
"workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
"compute": {
"kind": "ServerlessCompute"
},
"target": {
"kind": "AzureAISearch",
"connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
},
"datasource": {
"kind": "Dataset",
"datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
"datasetType": "uri_folder"
}
}
}
Ingestionjobruns — lista
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview
Wyświetla listę przebiegów określonego identyfikatora zadania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
| identyfikator zadania | ścieżka | Tak | ciąg | Identyfikator zadania. |
| token-użytkownika-mgmt | nagłówek | Nie. | ciąg | Token używany do uzyskiwania dostępu do obszaru roboczego (wymagany tylko w przypadku zadań obliczeniowych użytkownika). |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | IngestionJobRunList |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"value": [
{
"jobId": "ingestion-job",
"runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036",
"status": "succeeded"
},
{
"jobId": "ingestion-job",
"runId": "07f2d192-add7-4202-a2e3-858c2577f4fd",
"status": "failed"
},
{
"jobId": "ingestion-job",
"runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
"status": "running"
}
]
}
}
Ingestionjobruns – Pobierz
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview
Pobiera szczegóły określonego identyfikatora przebiegu w ramach określonego identyfikatora zadania.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
| identyfikator zadania | ścieżka | Tak | ciąg | Identyfikator zadania. |
| identyfikator uruchomienia | ścieżka | Tak | ciąg | Identyfikator przebiegu. |
| token-użytkownika-mgmt | nagłówek | Nie. | ciąg | Token używany do uzyskiwania dostępu do obszaru roboczego (wymagany tylko w przypadku zadań obliczeniowych użytkownika). |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | IngestionJobRun |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"body": {
"jobId": "ingestion-job",
"runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
"status": "running",
"progress": {
"stageProgress": [
{
"name": "Preprocessing",
"totalItems": 14,
"processedItems": 0,
"state": "notRunning"
},
{
"name": "Indexing",
"state": "notRunning"
}
]
}
}
}
Modele — lista
GET {endpoint}/openai/models?api-version=2025-04-01-preview
Pobiera listę wszystkich modeli, które są dostępne dla zasobu usługi Azure OpenAI.
Należą do nich modele podstawowe, a także wszystkie pomyślnie ukończone dostosowane modele należące do zasobu usługi Azure OpenAI.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Lista modeli |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/models?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"data": [
{
"status": "succeeded",
"capabilities": {
"fine_tune": true,
"inference": true,
"completion": true,
"chat_completion": false,
"embeddings": false
},
"lifecycle_status": `generally-available`,
"deprecation": {
"fine_tune": 1677662127,
"inference": 1709284527
},
"id": "curie",
"created_at": 1646126127,
"object": "model"
},
{
"status": "succeeded",
"model": "curie",
"fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"capabilities": {
"fine_tune": false,
"inference": true,
"completion": true,
"chat_completion": false,
"embeddings": false
},
"lifecycle_status": `generally-available`,
"deprecation": {
"inference": 1709284527
},
"id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "model"
}
],
"object": "list"
}
}
Modele – Pobierz
GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview
Pobiera szczegóły dla modelu określonego przez dany modelId.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| identyfikator modelu | ścieżka | Tak | ciąg | Identyfikator modelu. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Model |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"status": "succeeded",
"capabilities": {
"fine_tune": true,
"inference": true,
"completion": true,
"chat_completion": false,
"embeddings": false
},
"lifecycle_status": `generally-available`,
"deprecation": {
"fine_tune": 1677662127,
"inference": 1709284527
},
"id": "curie",
"created_at": 1646126127,
"object": "model"
}
}
GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"status": "succeeded",
"model": "curie",
"fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"capabilities": {
"fine_tune": false,
"inference": true,
"completion": true,
"chat_completion": false,
"embeddings": false
},
"lifecycle_status": `generally-available`,
"deprecation": {
"inference": 1709284527
},
"id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "model"
}
}
Przekazywanie pliku — uruchamianie
POST {endpoint}/openai/uploads?api-version=2025-04-01-preview
Tworzony jest obiekt przekazywania pośredniego, który umożliwia dodawanie do niego części. Obecnie rozmiar przekazywania może wynosić maksymalnie 9 GB i wygaśnie dwie godziny po utworzeniu.
Po zakończeniu przekazywania zostanie wygenerowany obiekt Plik zawierający wszystkie przekazane części. Ten obiekt File może być następnie używany na naszej platformie tak samo jak w przypadku każdego innego pliku.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: aplikacja/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| B | liczba całkowita | Tak | ||
| nazwa pliku | ciąg | Tak | ||
| typ MIME | ciąg | Tak | ||
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
Treść żądania
Typ zawartości: tekst/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| B | liczba całkowita | Tak | ||
| nazwa pliku | ciąg | Tak | ||
| typ MIME | ciąg | Tak | ||
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
Treść żądania
Typ zawartości: application/*+json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| B | liczba całkowita | Tak | ||
| nazwa pliku | ciąg | Tak | ||
| typ MIME | ciąg | Tak | ||
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
Odpowiedzi
Kod stanu: 200
Opis: Przesyłanie zostało pomyślnie utworzone.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | UploadResource |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/uploads?api-version=2025-04-01-preview
{
"purpose": "fine-tune",
"filename": "training_data_v21.jsonl",
"bytes": 2097152,
"mime_type": "application/json"
}
Odpowiedzi: Kod stanu: 200
{
"headers": {
"location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f"
},
"body": {
"bytes": 2097152,
"filename": "training_data_v21.jsonl",
"purpose": "fine-tune",
"status": "pending",
"expires_at": 1646133327,
"file": {
"status": "pending",
"bytes": 140,
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
},
"id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "upload"
}
}
Przekaż plik — anuluj
POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview
Anuluje przekazywanie i spowoduje usunięcie wszystkich przekazanych części asynchronicznie.
Po anulowaniu przekazywania nie można dodać żadnych części.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| upload-id | ścieżka | Tak | ciąg | Identyfikator przekazywania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | UploadResource |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"bytes": 2097152,
"filename": "training_data_v21.jsonl",
"purpose": "fine-tune",
"status": "cancelled",
"expires_at": 1646133327,
"file": {
"status": "pending",
"bytes": 140,
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
},
"id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "upload"
}
}
Przekazywanie pliku — ukończone
POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview
Spowoduje to ukończenie przekazywania, a zwrócony obiekt Upload zawiera zagnieżdżony obiekt Plik, który jest gotowy do użycia na całej platformie.
Kolejność części można zdefiniować, podając uporządkowaną listę identyfikatorów części.
Łączna liczba przekazanych bajtów musi być zgodna z rozmiarem określonym pierwotnie podczas tworzenia obiektu Upload.
Po zakończeniu operacji nie można dodać żadnych dodatkowych części.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| upload-id | ścieżka | Tak | ciąg | Identyfikator przekazywania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: aplikacja/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| md5 | ciąg | Nie. | ||
| part_ids | macierz | Tak |
Treść żądania
Typ zawartości: tekst/json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| md5 | ciąg | Nie. | ||
| part_ids | macierz | Tak |
Treść żądania
Typ zawartości: application/*+json
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| md5 | ciąg | Nie. | ||
| part_ids | macierz | Tak |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | UploadResource |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview
{
"part_ids": [
"LnmictL3p0u4LH/ko343nw==",
"LmmictL3p0u4LH/ko343nw=="
]
}
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"bytes": 2097152,
"filename": "training_data_v21.jsonl",
"purpose": "fine-tune",
"status": "completed",
"expires_at": 1646133327,
"file": {
"status": "processed",
"bytes": 140,
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
},
"id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "upload"
}
}
Przekazywanie pliku — część
POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview
Dodaje część do obiektu przesyłania, gdzie każda część to segment pliku, który przesyłasz.
Każda część może przekraczać standardowy limit rozmiaru dla przekazywania plików na podstawie przeznaczenia pliku. Możesz kontynuować dodawanie części do momentu osiągnięcia limitu rozmiaru przekazywania 9 GB.
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg URL |
Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com |
| upload-id | ścieżka | Tak | ciąg | Identyfikator przekazywania. |
| wersja API | kwerenda | Tak | ciąg | Żądana wersja interfejsu API. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Autoryzacja | Prawda | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizezakres: https://cognitiveservices.azure.com/.default |
| klucz API | Prawda | ciąg | Tutaj podaj klucz interfejsu API usługi Azure OpenAI |
Treść żądania
Typ zawartości: dane wielu części/formularzu
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | ciąg | Tak |
Odpowiedzi
Kod stanu: 200
Opis: Powodzenie
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | UploadPartResource |
Kod stanu: wartość domyślna
Opis: Wystąpił błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| aplikacja/json | Odpowiedź na błąd |
Przykłady
POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview
Odpowiedzi: Kod stanu: 200
{
"headers": {},
"body": {
"upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
"azure_block_id": "LnmictL3p0u4LH/ko343nw==",
"id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "upload.part"
}
}
Komponenty
Indeks wyszukiwania Azure AI
Indeks usługi Azure AI Search.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| identyfikator połączenia | ciąg | Identyfikator połączenia wskazującego indeks usługi Azure AI Search. | Nie. | |
| rodzaj | TargetType | Typ docelowy. | Tak |
Połączenie podstawowe
Połączenie z zasobem.
Dyskryminator dla podstawowego połączenia
Ten składnik używa właściwości kind do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rodzaj | Typ połączenia | Typ połączenia. | Tak |
Batch
Definiuje wartości partii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| anulowano_o | liczba całkowita | Sygnatura czasowa anulowania tej partii (w epokach unix). | Nie. | |
| anulowanie o | liczba całkowita | Sygnatura czasowa rozpoczęcia anulowania tej partii (w epokach unix). | Nie. | |
| zakończono_o | liczba całkowita | Sygnatura czasowa ukończenia tej partii (w epokach unix). | Nie. | |
| okno ukończenia | ciąg | Przedział czasu, w którym należy przetworzyć partię. | Nie. | |
| utworzono_o | liczba całkowita | Znacznik czasu, kiedy ta partia została utworzona (w epokach uniksowych). | Nie. | |
| punkt końcowy | ciąg | Punkt końcowy interfejsu API używany przez partię. | Nie. | |
| error_blob | ciąg | Adres URL obiektu blob zawierający dane wyjściowe żądań z błędami. | Nie. | |
| identyfikator_pliku_błędu | ciąg | Identyfikator pliku zawierającego dane wyjściowe żądań z błędami. | Nie. | |
| Błędy | BatchErrors | W przypadku partii, które zakończyły się niepowodzeniem, będzie to zawierać więcej informacji na temat przyczyny awarii. | Nie. | |
| wygasło_o | liczba całkowita | Sygnatura czasowa wygaśnięcia tej partii (w epokach systemu Unix). | Nie. | |
| wygasa_o | liczba całkowita | Czas wygaśnięcia tej partii (w epokach Unix). | Nie. | |
| nie powiodło się o | liczba całkowita | Sygnatura czasowa, gdy ta partia nie powiodła się (w epokach unix). | Nie. | |
| finalizowanie_w | liczba całkowita | Znacznik czasu rozpoczęcia finalizowania tej partii (w epokach unix). | Nie. | |
| id | ciąg | Tożsamość tego elementu. | Tak | |
| w_trakcie | liczba całkowita | Znacznik czasu, kiedy ta partia zaczęła postępować (w epoce unix). | Nie. | |
| input_blob | ciąg | Adres URL obiektu typu blob zawierający plik wejściowy dla zadania. | Nie. | |
| identyfikator_pliku_wejściowego | ciąg | Identyfikator pliku wejściowego dla partii. | Tak | |
| metadane | obiekt | Zestaw par klucz-wartość, które można dołączyć do zadania. Może to być przydatne do przechowywania dodatkowych informacji o partii w formacie ustrukturyzowanym. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| blob wyjściowy | ciąg | Adres URL obiektu blob zawierający dane wyjściowe pomyślnie wykonanych żądań. | Nie. | |
| identyfikator pliku wyjściowego | ciąg | Identyfikator pliku zawierającego dane wyjściowe pomyślnie wykonanych żądań. | Nie. | |
| liczba_żądań | BatchRequestCounts | Liczba żądań dla różnych stanów w partii. | Nie. | |
| stan | BatchStatus | Stan partii. | Nie. |
ŻądanieMasowegoTworzenia
Definiuje żądanie utworzenia partii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| okno ukończenia | ciąg | Przedział czasu, w którym należy przetworzyć partię. | Tak | |
| punkt końcowy | ciąg | Punkt końcowy interfejsu API używany przez partię. | Tak | |
| input_blob | ciąg | Adres URL obiektu blob usługi Azure Storage do użycia jako dane wejściowe dla zadania przetwarzania wsadowego. | Nie. | |
| identyfikator_pliku_wejściowego | ciąg | Identyfikator pliku wejściowego dla partii. | Nie. | |
| metadane | obiekt | Zestaw par klucz-wartość, które można dołączyć do zadania. Może to być przydatne do przechowywania dodatkowych informacji o partii w formacie ustrukturyzowanym. | Nie. | |
| wynik_wygasa_po | PlikExpiresAfter | Definiuje wygaśnięcie pliku. | Nie. | |
| folder_wyjściowy | BatchOutputReference | Folder usługi Azure Storage do przechowywania danych wyjściowych. | Nie. |
BatchErrorData
Informacje o błędzie niepowodzenia w partii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| kod | ciąg | Kod błędu identyfikujący typ błędu. | Nie. | |
| linia | ciąg | Numer wiersza pliku wejściowego, w którym wystąpił błąd, jeśli ma to zastosowanie (może mieć wartość null). | Nie. | |
| komunikat | ciąg | Czytelny dla człowieka komunikat zawierający więcej szczegółów na temat błędu. | Nie. | |
| Param | ciąg | Nazwa parametru, który spowodował błąd, jeśli ma zastosowanie (może mieć wartość null). | Nie. |
BatchErrors
W przypadku partii, które zakończyły się niepowodzeniem, będzie to zawierać więcej informacji na temat przyczyny awarii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | BatchErrorData | Informacje o błędzie niepowodzenia w partii. | Nie. | |
| obiekt | ciąg | Typ obiektu errors. Jest to zawsze "lista". | Nie. |
BatchRequestCounts
Liczba żądań dla różnych stanów w partii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| zakończono | liczba całkowita | Liczba żądań w grupie, ukończonych pomyślnie. | Nie. | |
| niepowodzenie | liczba całkowita | Liczba żądań w partii, które zakończyły się niepowodzeniem. | Nie. | |
| łączny | liczba całkowita | Całkowita liczba żądań w wsadzie. | Nie. |
BatchOutputReference
Folder usługi Azure Storage do przechowywania danych wyjściowych.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| ogranicznik | ciąg | Opcjonalny. Ogranicznik używany w ścieżce folderu domyślnie /. | Nie. | |
| URL | ciąg | Adres URL folderu usługi Azure Storage, w którym zostaną zapisane dane wyjściowe wsadowe. | Nie. |
BatchStatus
Stan partii.
| Majątek | Wartość |
|---|---|
| Opis | Stan partii. |
| Typ | ciąg |
| Wartości | validatingfailedin_progressfinalizingcompletedexpiredcancellingcancelled |
BatchesList
Reprezentuje listę serii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista elementów. | Nie. | |
| first_id | ciąg | Identyfikator pierwszej partii na liście zwróconych partii. | Nie. | |
| zawiera_więcej | typ logiczny (boolowski) | Wartość wskazująca, czy lista zawiera więcej elementów niż zwracane. | Nie. | |
| last_id | ciąg | Identyfikator ostatniej partii na liście zwróconych partii. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. |
Możliwości
Możliwości modelu podstawowego lub precyzyjnego dostrajania.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| uzupełnianie czatu | typ logiczny (boolowski) | Wartość wskazująca, czy model obsługuje uzupełnianie czatu. | Tak | |
| ukończenie | typ logiczny (boolowski) | Wartość wskazująca, czy model obsługuje uzupełnianie. | Tak | |
| osadzanie | typ logiczny (boolowski) | Wartość wskazująca, czy model obsługuje osadzanie. | Tak | |
| fine_tune | typ logiczny (boolowski) | Wartość wskazująca, czy można użyć modelu do dostrajania. | Tak | |
| Wnioskowanie | typ logiczny (boolowski) | Wartość wskazująca, czy można wdrożyć model. | Tak |
Wybór
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| powód zakończenia | ciąg | Przyczyna, dla którego model przestał generować tokeny. | Nie. | |
| indeks | liczba całkowita | Indeks wybranego elementu na liście opcji. | Nie. | |
| logprobs | obiekt | Informacje o logarytmicznym prawdopodobieństwie dla wybranej opcji. | Nie. | |
| komunikat | ChoiceMessage | Nie. |
Wiadomość o wyborze
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| zawartość | ciąg | Zawartość wiadomości. | Nie. | |
| rola | ciąg | Rola jednostki tworzącej komunikat. | Nie. | |
| wywołania_narzędzi | macierz | Lista odpowiednich wywołań narzędzi. | Nie. |
UstawieniaChunkingu
Ustawienia fragmentowania
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| MaksymalnyRozmiarSegmentuWTokensach | liczba całkowita | Nie. |
Zakończenieakcja
Akcja ukończenia.
| Majątek | Wartość |
|---|---|
| Opis | Akcja ukończenia. |
| Typ | ciąg |
| Wartości | cleanUpTempAssetskeepAllAssets |
Typ obliczeniowy
Typ obliczeniowy.
| Majątek | Wartość |
|---|---|
| Opis | Typ obliczeniowy. |
| Typ | ciąg |
| Wartości | ServerlessComputeCustomCompute |
PołączenieConnectionString
Połączenie parametrów połączenia.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Parametry połączenia | ciąg | Łańcuch połączenia | Nie. | |
| rodzaj | Typ połączenia | Typ połączenia. | Tak |
Typ Połączenia
Typ połączenia.
| Majątek | Wartość |
|---|---|
| Opis | Typ połączenia. |
| Typ | ciąg |
| Wartości | EndpointWithKeyConnectionStringEndpointWithManagedIdentityWorkspaceConnectionRelativeConnection |
Indeks CosmosDB
Indeks usługi CosmosDB.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| nazwaKolekcji | ciąg | Nazwa kolekcji cosmos DB. | Nie. | |
| identyfikator połączenia | ciąg | Identyfikator połączenia wskazującego usługę Cosmos DB. | Nie. | |
| nazwaBazyDanych | ciąg | Nazwa bazy danych cosmos DB. | Nie. | |
| rodzaj | TargetType | Typ docelowy. | Tak |
PrzeszukiwanieUstawienia
Ustawienia przeszukiwania
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| maxCrawlDepth (maksymalna głębokość przeszukiwania) | liczba całkowita | Nie. | ||
| maksCzasSkanowaniaWMinutach | liczba całkowita | Nie. | ||
| maksCzasPobieraniaWMinutach | liczba całkowita | Nie. | ||
| maksymalna_wielkość_pliku | liczba całkowita | Nie. | ||
| maxFiles | liczba całkowita | Nie. | ||
| Maksymalna liczba przekierowań (maxRedirects) | liczba całkowita | Nie. |
UtwórzŹródłoDanychDlaWykonywaniaKompletacjiEwaluacji
Obiekt CompletionsRunDataSource opisujący konfigurację próbkowania modelu.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| wiadomości wejściowe | obiekt | Nie. | ||
| └item_reference | ciąg | Odwołanie do zmiennej w przestrzeni nazw "item", np. "item.name". | Nie. | |
| └─ szablon | macierz | Lista wiadomości czatu tworzących monit lub kontekst. Może zawierać odwołania zmiennych do przestrzeni nazw "item", np. {{item.name}}. | Nie. | |
| └typ | wyliczenie | Typ komunikatów wejściowych.
template lub item_reference.Możliwe wartości: template, item_reference |
Nie. | |
| model | ciąg | Nazwa modelu do generowania uzupełnień (np. "o3-mini"). | Nie. | |
| parametry_próbowania | obiekt | Nie. | ||
| └max_completion_tokens | liczba całkowita | Maksymalna liczba tokenów w wygenerowanych danych wyjściowych. | Nie. | |
| └─ nasion | liczba całkowita | Wartość początkowa do inicjowania losowości podczas próbkowania. | Nie. | 42 |
| └* temperatura | Liczba | Wyższa temperatura zwiększa losowość w danych wyjściowych. | Nie. | 1 |
| └─top_p | Liczba | Alternatywą dla temperatury próbkowania jądra; 1.0 zawiera wszystkie tokeny. | Nie. | 1 |
| przesłać źródło | obiekt | Tak | ||
| └typ | wyliczenie | Typ źródła. Może być jednym z EvalJsonlFileContentSource, EvalJsonlFileIdSource lub EvalStoredCompletionsSource.Możliwe wartości: EvalJsonlFileContentSource, , EvalJsonlFileIdSourceEvalStoredCompletionsSource |
Nie. | |
| typ | wyliczenie | Typ uruchomionego źródła danych. Zawsze completions.Możliwe wartości: completions |
Tak |
UtwórzKonfiguracjęWłasnegoŹródłaDanychDoEwaluacji
Obiekt CustomDataSourceConfig, który definiuje schemat źródła danych używanego do przeprowadzania serii ocen. Ten schemat służy do definiowania kształtu danych, które będą: — służy do definiowania kryteriów testowania i — jakie dane są wymagane podczas tworzenia przebiegu
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| uwzględnij_przykładowy_schemat | typ logiczny (boolowski) | Czy podczas oceny należy oczekiwać wypełnienia przykładowej przestrzeni nazw (tj. przez generowanie odpowiedzi ze źródła danych) | Nie. | Nieprawda |
| item_schema | obiekt | Schemat JSON dla każdego wiersza w źródle danych. | Tak | |
| typ | wyliczenie | Typ źródła danych. Zawsze custom.Możliwe wartości: custom |
Tak |
UtwórzEvalElement
Wiadomość czatu, która tworzy monit lub kontekst. Może zawierać odwołania zmiennych do przestrzeni nazw "item", tj. {{item.name}}.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| zawartość | ['string', 'InputTextContent', 'object'] | Wprowadzanie tekstu do modelu — może zawierać ciągi szablonu. | Tak | |
| rola | wyliczenie | Rola wejścia komunikatu.
userJeden z , assistant, systemlub developer.Możliwe wartości: user, , assistant, systemdeveloper |
Tak | |
| typ | wyliczenie | Typ danych wejściowych komunikatu. Zawsze message.Możliwe wartości: message |
Nie. |
UtwórzŹródłoDanychEvalJsonlRun
Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| przesłać źródło | obiekt | Tak | ||
| └─ zawartość | macierz | Zawartość pliku jsonl. | Nie. | |
| └─ ID | ciąg | Identyfikator pliku. | Nie. | |
| └typ | wyliczenie | Typ źródła jsonl. Zawsze file_id.Możliwe wartości: file_id |
Nie. | |
| typ | wyliczenie | Typ źródła danych. Zawsze jsonl.Możliwe wartości: jsonl |
Tak |
CreateEvalLabelModelGrader
Obiekt LabelModelGrader, który używa modelu do przypisywania etykiet do każdego elementu w ocenie.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane wejściowe | macierz | Lista wiadomości czatu tworzących monit lub kontekst. Może zawierać odwołania zmiennych do przestrzeni nazw "item", tj. {{item.name}}. | Tak | |
| etykiety | macierz | Etykiety do klasyfikacji każdego elementu w ocenie. | Tak | |
| model | ciąg | Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą. | Tak | |
| nazwa | ciąg | Nazwa oceniającego. | Tak | |
| przechodzące_etykiety | macierz | Etykiety wskazujące wynik pozytywny. Musi być podzbiorem etykiet. | Tak | |
| typ | wyliczenie | Typ obiektu, który jest zawsze label_model.Możliwe wartości: label_model |
Tak |
CreateEvalLogsDataSourceConfig (KonfiguracjaŹródłaDanychDziennikówEwaluacji)
Konfiguracja źródła danych, która określa właściwość metadanych przechowywanego zapytania uzupełniania. Zazwyczaj są to metadane, takie jak usecase=chatbot lub prompt-version=v2, itp.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| metadane | obiekt | Filtry metadanych dla źródła danych dzienników. | Nie. | |
| typ | wyliczenie | Typ źródła danych. Zawsze logs.Możliwe wartości: logs |
Tak |
UtwórzŻądanieOceny
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| konfiguracja źródła danych | obiekt | Obiekt CustomDataSourceConfig, który definiuje schemat źródła danych używanego do przeprowadzania serii ocen. Ten schemat służy do definiowania kształtu danych, które będą: — służy do definiowania kryteriów testowania i — jakie dane są wymagane podczas tworzenia przebiegu | Tak | |
| └ dołącz_przykładowy_schemat | typ logiczny (boolowski) | Czy podczas oceny należy oczekiwać wypełnienia przykładowej przestrzeni nazw (tj. przez generowanie odpowiedzi ze źródła danych) | Nie. | Nieprawda |
| └item_schema | obiekt | Schemat JSON dla każdego wiersza w źródle danych. | Nie. | |
| Metadane └* | obiekt | Filtry metadanych dla źródła danych dzienników. | Nie. | |
| └typ | wyliczenie | Typ źródła danych. Zawsze logs.Możliwe wartości: logs |
Nie. | |
| metadane | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Nie. | |
| nazwa | ciąg | Nazwa oceny. | Nie. | |
| kryteria_testowe | macierz | Lista osób oceniających dla wszystkich przebiegów oceny w tej grupie. | Tak |
CreateEvalRunRequest
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| źródło danych | obiekt | Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji. | Tak | |
| └input_messages | obiekt | Nie. | ||
| └item_reference | ciąg | Odwołanie do zmiennej w przestrzeni nazw "item", np. "item.name". | Nie. | |
| └─ szablon | macierz | Lista wiadomości czatu tworzących monit lub kontekst. Może zawierać odwołania zmiennych do przestrzeni nazw "item", np. {{item.name}}. | Nie. | |
| └typ | wyliczenie | Typ komunikatów wejściowych.
template lub item_reference.Możliwe wartości: template, item_reference |
Nie. | |
| Model └* | ciąg | Nazwa modelu do generowania uzupełnień (np. "o3-mini"). | Nie. | |
| └parametry_próbkowania | obiekt | Nie. | ||
| └max_completion_tokens | liczba całkowita | Maksymalna liczba tokenów w wygenerowanych danych wyjściowych. | Nie. | |
| └─ nasion | liczba całkowita | Wartość początkowa do inicjowania losowości podczas próbkowania. | Nie. | 42 |
| └* temperatura | Liczba | Wyższa temperatura zwiększa losowość w danych wyjściowych. | Nie. | 1 |
| └─top_p | Liczba | Alternatywą dla temperatury próbkowania jądra; 1.0 zawiera wszystkie tokeny. | Nie. | 1 |
| └— źródło | obiekt | Nie. | ||
| └typ | wyliczenie | Typ źródła. Może być jednym z EvalJsonlFileContentSource, EvalJsonlFileIdSource lub EvalStoredCompletionsSource.Możliwe wartości: EvalJsonlFileContentSource, , EvalJsonlFileIdSourceEvalStoredCompletionsSource |
Nie. | |
| └typ | wyliczenie | Typ uruchomionego źródła danych. Zawsze completions.Możliwe wartości: completions |
Nie. | |
| metadane | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Nie. | |
| nazwa | ciąg | Nazwa przebiegu. | Nie. |
UtwórzŹródłoDanychDlaPrzebieguZapisanychUkończonychEwaluacji
Konfiguracja StoredCompletionsRunDataSource opisująca zestaw filtrów
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| stworzone_po | liczba całkowita | Opcjonalny znacznik czasu systemu Unix do filtrowania elementów utworzonych po tym czasie. | Nie. | |
| utworzone_przed | liczba całkowita | Opcjonalny znacznik czasu systemu Unix do filtrowania elementów utworzonych przed tym czasem. | Nie. | |
| limit / ograniczenie | liczba całkowita | Opcjonalna maksymalna liczba elementów do zwrócenia. | Nie. | |
| metadane | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Nie. | |
| model | ciąg | Opcjonalny model filtrowania (np. „gpt-4o”). | Nie. | |
| typ | wyliczenie | Typ źródła danych. Zawsze stored_completions.Możliwe wartości: stored_completions |
Tak |
CustomCompute
Niestandardowe obliczenia.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| computeId (identyfikator obliczeniowy) | ciąg | Identyfikator obliczeń niestandardowych | Nie. | |
| rodzaj | Typ obliczeniowy | Typ obliczeniowy. | Tak |
DeploymentConnection
Względne połączenie wdrożenia.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rodzaj | Typ połączenia | Typ połączenia. | Tak |
Wycofanie
Definiuje daty wycofania dla różnych przypadków użycia modelu.
Zazwyczaj modele podstawowe obsługują 1 rok dostrajania po utworzeniu. Wnioskowanie jest zwykle obsługiwane 2 lata po utworzeniu podstawowych lub dostrojonych modeli. Dokładne daty są określone we właściwościach.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| fine_tune | liczba całkowita | Data zakończenia dokładnego dostosowania obsługi tego modelu. Będzie null w celu dostosowania modeli. |
Nie. | |
| Wnioskowanie | liczba całkowita | Data zakończenia obsługi wnioskowania tego modelu. | Tak |
DpoHyperparamsRequest
Hiperparametry metody dostrajania DPO
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rozmiar partii | liczba całkowita | Rozmiar partii do użycia do treningu. Rozmiar partii to liczba przykładów trenowania używanych do trenowania pojedynczego przebiegu do przodu i do tyłu. Ogólnie rzecz biorąc, odkryliśmy, że większe rozmiary partii zwykle działają lepiej w przypadku większych zestawów danych. Wartość domyślna, a także maksymalna wartość tej właściwości są specyficzne dla modelu podstawowego. | Nie. | |
| wersja beta | Liczba | Wartość beta obiektu DPO. | Nie. | |
| mnożnik_l2 | Liczba | Mnożnik regularyzacji L2 | Nie. | |
| mnożnik szybkości uczenia | Liczba | Mnożnik szybkości nauki używany do trenowania. Współczynnik dostrajania uczenia to oryginalny współczynnik uczenia, który był używany do wstępnego trenowania, pomnożony przez tę wartość. Większe współczynniki uczenia się zwykle działają lepiej z większymi wielkościami partii. Zalecamy eksperymentowanie z wartościami z zakresu od 0,02 do 0,2, aby zobaczyć, co daje najlepsze wyniki. | Nie. | |
| n_epochs (liczba epok) | liczba całkowita | Liczba epok treningu dla modelu. Epoka odnosi się do jednego pełnego cyklu przez zestaw danych szkoleniowych. | Nie. |
DpoMethod
Prośba o ulepszenie metody DPO
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
dpo |
DpoMethodConfigRequest | Konfiguracja metody dpo dostrajania. Zawiera hiperparametry specyficzne dla DPO |
Tak | |
| typ | FineTuningMethodType | Tak |
ŻądanieKonfiguracjiMetodyDpo
Konfiguracja metody dpo dostrajania. Zawiera hiperparametry specyficzne dla DPO
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| hiperparametry | DpoHyperparamsRequest | Hiperparametry metody dostrajania DPO | Nie. |
DpoMethodRequest
Prośba o ulepszenie metody DPO
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
dpo |
DpoMethodConfigRequest | Konfiguracja metody dpo dostrajania. Zawiera hiperparametry specyficzne dla DPO |
Tak | |
| typ | FineTuningMethodType | Tak |
EndpointKeyConnection
Połączenie klucza punktu końcowego.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| punkt końcowy | ciąg | Punkt końcowy | Nie. | |
| klucz | ciąg | Klawisz | Nie. | |
| rodzaj | Typ połączenia | Typ połączenia. | Tak |
EndpointMIConnection
Połączenie tożsamości zarządzanej punktu końcowego.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| punkt końcowy | ciąg | Punkt końcowy | Nie. | |
| rodzaj | Typ połączenia | Typ połączenia. | Tak | |
| identyfikator zasobu | ciąg | Identyfikator zasobu | Nie. |
Błąd
Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| kod | Kod błędu | Kody błędów zdefiniowane w wytycznych REST firmy Microsoft. | Tak | |
| Szczegóły | macierz | Szczegóły błędu, jeśli są dostępne. | Nie. | |
innererror |
InnerError | Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft. | Nie. | |
| komunikat | ciąg | Komunikat o tym błędzie. | Tak | |
| miejsce docelowe | ciąg | Lokalizacja, w której wystąpił błąd, jeśli jest dostępny. | Nie. |
Kod błędu
Kody błędów zdefiniowane w wytycznych REST firmy Microsoft.
| Majątek | Wartość |
|---|---|
| Opis | Kody błędów zdefiniowane w wytycznych REST firmy Microsoft. |
| Typ | ciąg |
| Wartości | conflictinvalidPayloadforbiddennotFoundunexpectedEntityStateitemDoesAlreadyExistserviceUnavailableinternalFailurequotaExceededjsonlValidationFailedfileImportFailedtooManyRequestsunauthorizedcontentFilter |
Odpowiedź na błąd
Odpowiedź na błąd zgodnie z definicją w wytycznych REST firmy Microsoft.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| błąd | Błąd | Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft. | Tak |
Ewaluacja
Obiekt Eval z konfiguracją źródła danych i kryteriami testowania. Eval reprezentuje zadanie, które należy wykonać na potrzeby Twojej integracji z LLM. Lubić:
- Poprawianie jakości mojego czatbota
- Zobacz, jak dobrze mój czatbot obsługuje obsługę klienta
- Sprawdź, czy o3-mini jest lepiej w moim przypadku użycia niż gpt-4o
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) wskazująca moment utworzenia oceny. | Tak | |
| konfiguracja źródła danych | obiekt | CustomDataSourceConfig, który określa schemat twojej przestrzeni nazw item oraz opcjonalnie przestrzeni nazw sample. Schemat odpowiedzi definiuje kształt danych, które będą: — służy do definiowania kryteriów testowania i — jakie dane są wymagane podczas tworzenia przebiegu |
Tak | |
| Metadane └* | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Nie. | |
| Schemat └* | obiekt | Schemat json dla elementów uruchomiania źródła danych. Dowiedz się, jak tworzyć schematy JSON tutaj. | Nie. | |
| └typ | wyliczenie | Typ źródła danych. Zawsze stored_completions.Możliwe wartości: stored_completions |
Nie. | |
| id | ciąg | Unikatowy identyfikator oceny. | Tak | |
| metadane | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Tak | |
| nazwa | ciąg | Nazwa oceny. | Tak | |
| obiekt | wyliczenie | Typ obiektu. Możliwe wartości: eval |
Tak | |
| kryteria_testowe | macierz | Lista kryteriów testowania. | Tak |
EvalApiError
Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| kod | ciąg | Kod błędu. | Tak | |
| komunikat | ciąg | Komunikat o błędzie. | Tak |
EvalCustomDataSourceConfig
CustomDataSourceConfig, który określa schemat twojej przestrzeni nazw item oraz opcjonalnie przestrzeni nazw sample. Schemat odpowiedzi definiuje kształt danych, które będą: — służy do definiowania kryteriów testowania i — jakie dane są wymagane podczas tworzenia przebiegu
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| schemat | obiekt | Schemat json dla elementów uruchomiania źródła danych. Dowiedz się, jak tworzyć schematy JSON tutaj. | Tak | |
| typ | wyliczenie | Typ źródła danych. Zawsze custom.Możliwe wartości: custom |
Tak |
EvalFileRunDataSource
Konfiguracja FileRunDataSource z identyfikatorem pliku
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| identyfikator_pliku | ciąg | Identyfikator pliku. | Tak | |
| typ | wyliczenie | Typ źródła danych. Zawsze file.Możliwe wartości: file |
Tak |
EvalItem
Wiadomość jako wejście do modelu z rolą wskazującą przestrzeganie hierarchii instrukcji. Instrukcje przypisane do roli developer lub system mają pierwszeństwo przed instrukcjami przypisanymi do roli user. Przyjmuje się, że komunikaty z rolą assistant zostały wygenerowane przez model w poprzednich interakcjach.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| zawartość | obiekt | Wprowadzanie tekstu do modelu. | Tak | |
| └* tekst | ciąg | Dane wyjściowe tekstu z modelu. | Nie. | |
| └typ | wyliczenie | Typ tekstu wyjściowego. Zawsze output_text.Możliwe wartości: output_text |
Nie. | |
| rola | wyliczenie | Rola wejścia komunikatu.
userJeden z , assistant, systemlub developer.Możliwe wartości: user, , assistant, systemdeveloper |
Tak | |
| typ | wyliczenie | Typ danych wejściowych komunikatu. Zawsze message.Możliwe wartości: message |
Nie. |
EvalJsonlFileContentSource
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| zawartość | macierz | Zawartość pliku jsonl. | Tak | |
| typ | wyliczenie | Typ źródła jsonl. Zawsze file_content.Możliwe wartości: file_content |
Tak |
EvalJsonlPlikIdZrodlo
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| id | ciąg | Identyfikator pliku. | Tak | |
| typ | wyliczenie | Typ źródła jsonl. Zawsze file_id.Możliwe wartości: file_id |
Tak |
EvalLabelModelGrader
Obiekt LabelModelGrader, który używa modelu do przypisywania etykiet do każdego elementu w ocenie.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane wejściowe | macierz | Tak | ||
| etykiety | macierz | Etykiety do przypisania do każdego elementu w ocenie. | Tak | |
| model | ciąg | Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą. | Tak | |
| nazwa | ciąg | Nazwa oceniającego. | Tak | |
| przechodzące_etykiety | macierz | Etykiety wskazujące wynik pozytywny. Musi być podzbiorem etykiet. | Tak | |
| typ | wyliczenie | Typ obiektu, który jest zawsze label_model.Możliwe wartości: label_model |
Tak |
EvalList
Obiekt reprezentujący listę ocen.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Tablica obiektów owalnych. | Tak | |
| first_id | ciąg | Identyfikator pierwszej ewaluacji w tablicy danych. | Tak | |
| zawiera_więcej | typ logiczny (boolowski) | Wskazuje, czy jest dostępnych więcej ewaluacji. | Tak | |
| last_id | ciąg | Identyfikator ostatniej ewaluacji w tablicy danych. | Tak | |
| obiekt | wyliczenie | Typ tego obiektu. Zawsze jest ustawione na "list". Możliwe wartości: list |
Tak |
EvalRun
Schemat reprezentujący przebieg oceny.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) podczas tworzenia przebiegu oceny. | Tak | |
| źródło danych | obiekt | Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji. | Tak | |
| └input_messages | obiekt | Nie. | ||
| └item_reference | ciąg | Odwołanie do zmiennej w przestrzeni nazw "item", np. "item.name". | Nie. | |
| └─ szablon | macierz | Lista wiadomości czatu tworzących monit lub kontekst. Może zawierać odwołania zmiennych do przestrzeni nazw "item", np. {{item.name}}. | Nie. | |
| └typ | wyliczenie | Typ komunikatów wejściowych.
template lub item_reference.Możliwe wartości: template, item_reference |
Nie. | |
| Model └* | ciąg | Nazwa modelu do generowania uzupełnień (np. "o3-mini"). | Nie. | |
| └parametry_próbkowania | obiekt | Nie. | ||
| └max_completion_tokens | liczba całkowita | Maksymalna liczba tokenów w wygenerowanych danych wyjściowych. | Nie. | |
| └─ nasion | liczba całkowita | Wartość początkowa do inicjowania losowości podczas próbkowania. | Nie. | 42 |
| └* temperatura | Liczba | Wyższa temperatura zwiększa losowość w danych wyjściowych. | Nie. | 1 |
| └─top_p | Liczba | Alternatywą dla temperatury próbkowania jądra; 1.0 zawiera wszystkie tokeny. | Nie. | 1 |
| └— źródło | obiekt | Nie. | ||
| └typ | wyliczenie | Typ źródła. Może być jednym z EvalJsonlFileContentSource, EvalJsonlFileIdSource lub EvalStoredCompletionsSource.Możliwe wartości: EvalJsonlFileContentSource, , EvalJsonlFileIdSourceEvalStoredCompletionsSource |
Nie. | |
| └typ | wyliczenie | Typ uruchomionego źródła danych. Zawsze completions.Możliwe wartości: completions |
Nie. | |
| błąd | EvalApiError | Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval. | Tak | |
| eval_id | ciąg | Identyfikator skojarzonej oceny. | Tak | |
| id | ciąg | Unikatowy identyfikator przebiegu oceny. | Tak | |
| metadane | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Tak | |
| model | ciąg | Model, który jest oceniany, jeśli ma zastosowanie. | Tak | |
| nazwa | ciąg | Nazwa przebiegu oceny. | Tak | |
| obiekt | wyliczenie | Typ obiektu. Zawsze "eval.run". Możliwe wartości: eval.run |
Tak | |
| użycie na model | macierz | Statystyki użycia dla każdego modelu podczas przebiegu oceny. | Tak | |
| wyniki_wg_kryteriów_testowych | macierz | Wyniki na kryteria testowania stosowane podczas przebiegu oceny. | Tak | |
| report_url | ciąg | Adres URL wyświetlonego raportu przebiegu oceny na pulpicie interfejsu użytkownika. | Tak | |
| wyniki_liczby | obiekt | Liczniki podsumowujące wyniki przebiegu oceny. | Tak | |
| └─ Wystąpił błąd | liczba całkowita | Liczba elementów wyjściowych, które spowodowały błąd. | Nie. | |
| └* nie powiodło się | liczba całkowita | Liczba elementów wyjściowych, które nie przeszły oceny. | Nie. | |
| └* zaliczone | liczba całkowita | Liczba elementów wyjściowych, które przeszły ocenę. | Nie. | |
| └─ suma | liczba całkowita | Łączna liczba wykonanych elementów wyjściowych. | Nie. | |
| stan | ciąg | Stan przebiegu oceny. | Tak |
EvalRunList
Obiekt reprezentujący listę przebiegów oceny.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Tablica obiektów testowych uruchomień. | Tak | |
| first_id | ciąg | Identyfikator pierwszego przebiegu oceny w tablicy danych. | Tak | |
| zawiera_więcej | typ logiczny (boolowski) | Wskazuje, czy jest dostępnych więcej ewaluacji. | Tak | |
| last_id | ciąg | Identyfikator ostatniego przebiegu oceny w tablicy danych. | Tak | |
| obiekt | wyliczenie | Typ tego obiektu. Zawsze jest ustawione na "list". Możliwe wartości: list |
Tak |
EvalRunOutputItem
Schemat reprezentujący element wyjściowy przebiegu oceny.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) podczas tworzenia przebiegu oceny. | Tak | |
| element źródła danych | obiekt | Szczegóły elementu wejściowego źródła danych. | Tak | |
| "identyfikator_elementu_źródła_danych (datasource_item_id)" | liczba całkowita | Identyfikator elementu źródła danych. | Tak | |
| eval_id | ciąg | Identyfikator grupy ewaluacyjnej. | Tak | |
| id | ciąg | Unikatowy identyfikator elementu wyjściowego procesu oceny. | Tak | |
| obiekt | wyliczenie | Typ obiektu. Zawsze "eval.run.output_item". Możliwe wartości: eval.run.output_item |
Tak | |
| Wyniki | macierz | Lista wyników z przebiegu oceny. | Tak | |
| identyfikator_uruchomienia | ciąg | Identyfikator przebiegu oceny skojarzonego z tym elementem wyjściowym. | Tak | |
| próbka | obiekt | Przykład zawierający dane wejściowe i wyjściowe przebiegu oceny. | Tak | |
| └─ błąd | EvalApiError | Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval. | Nie. | |
| └ finish_reason | ciąg | Powód zakończenia generowania próbki. | Nie. | |
| └─ Wejście | macierz | Tablica komunikatów wejściowych. | Nie. | |
| └max_completion_tokens | liczba całkowita | Maksymalna liczba tokenów dozwolonych do ukończenia. | Nie. | |
| Model └* | ciąg | Model używany do generowania przykładu. | Nie. | |
| └─ Dane wyjściowe | macierz | Tablica komunikatów wyjściowych. | Nie. | |
| └─ nasion | liczba całkowita | Nasiono używane do generowania próbki. | Nie. | |
| └* temperatura | Liczba | Użyta temperatura próbkowania. | Nie. | |
| └─top_p | Liczba | Wartość top_p używana do próbkowania. | Nie. | |
| └─ użycie | obiekt | Szczegóły użycia tokenu dla przykładu. | Nie. | |
| └cached_tokens | liczba całkowita | Liczba tokenów pobranych z pamięci podręcznej. | Nie. | |
| └─ tokeny_zakończenia | liczba całkowita | Liczba wygenerowanych tokenów ukończenia. | Nie. | |
| └prompt_tokens | liczba całkowita | Liczba użytych tokenów wywołania. | Nie. | |
| └total_tokens | liczba całkowita | Całkowita liczba użytych tokenów. | Nie. | |
| stan | ciąg | Stan przebiegu oceny. | Tak |
Lista elementów wynikowych uruchomienia ewaluacji
Obiekt reprezentujący listę elementów wyjściowych dla przebiegu oceny.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Tablica obiektów elementów wyjściowych z przebiegu eval. | Tak | |
| first_id | ciąg | Identyfikator pierwszego elementu wyjściowego przebiegu oceny w tablicy danych. | Tak | |
| zawiera_więcej | typ logiczny (boolowski) | Wskazuje, czy dostępnych jest więcej elementów wyjściowych przebiegu oceny. | Tak | |
| last_id | ciąg | Identyfikator ostatniego elementu wyjściowego przebiegu eval w tablicy danych. | Tak | |
| obiekt | wyliczenie | Typ tego obiektu. Zawsze jest ustawione na "list". Możliwe wartości: list |
Tak |
Grader oceny modelu EvalScore
Obiekt ScoreModelGrader, który używa modelu do przypisania wyniku do danych wejściowych.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane wejściowe | macierz | Tekst wejściowy. Może to obejmować ciągi szablonu. | Tak | |
| model | ciąg | Model do użycia do oceny. | Tak | |
| nazwa | ciąg | Nazwa oceniającego. | Tak | |
| próg zaliczenia | Liczba | Próg dla wyniku. | Nie. | |
| zakres | macierz | Zakres wyniku Wartość domyślna to [0, 1]. |
Nie. | |
| parametry_próbowania | obiekt | Parametry próbkowania dla modelu. | Nie. | |
| typ | wyliczenie | Typ obiektu, który jest zawsze score_model.Możliwe wartości: score_model |
Tak |
KonfiguracjaŹródłaDanychDoEvalStoredCompletions
Wartość StoredCompletionsDataSourceConfig określająca właściwość metadanych przechowywanego zapytania uzupełniania. Zazwyczaj są to metadane, takie jak usecase=chatbot lub prompt-version=v2, itp. Schemat zwracany przez tę konfigurację źródła danych służy do określania, jakie zmienne są dostępne w ewalach.
item i sample są definiowane podczas korzystania z tej konfiguracji źródła danych.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| metadane | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Nie. | |
| schemat | obiekt | Schemat json dla elementów uruchomiania źródła danych. Dowiedz się, jak tworzyć schematy JSON tutaj. | Tak | |
| typ | wyliczenie | Typ źródła danych. Zawsze stored_completions.Możliwe wartości: stored_completions |
Tak |
ŹródłoUkończeńEvalStored
Konfiguracja StoredCompletionsRunDataSource opisująca zestaw filtrów
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| stworzone_po | liczba całkowita | Opcjonalny znacznik czasu systemu Unix do filtrowania elementów utworzonych po tym czasie. | Nie. | |
| utworzone_przed | liczba całkowita | Opcjonalny znacznik czasu systemu Unix do filtrowania elementów utworzonych przed tym czasem. | Nie. | |
| limit / ograniczenie | liczba całkowita | Opcjonalna maksymalna liczba elementów do zwrócenia. | Nie. | |
| metadane | Metadane | Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków. | Nie. | |
| model | ciąg | Opcjonalny model filtrowania (np. „gpt-4o”). | Nie. | |
| typ | wyliczenie | Typ źródła. Zawsze stored_completions.Możliwe wartości: stored_completions |
Tak |
EvalStringCheckGrader
Obiekt StringCheckGrader, który wykonuje porównanie ciągów między danymi wejściowymi i odwołaniami przy użyciu określonej operacji.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane wejściowe | ciąg | Tekst wejściowy. Może to obejmować ciągi szablonu. | Tak | |
| nazwa | ciąg | Nazwa oceniającego. | Tak | |
| operacja | wyliczenie | Operacja sprawdzania ciągów, którą należy wykonać.
eqJeden z , ne, likelub ilike.Możliwe wartości: eq, , ne, likeilike |
Tak | |
| odwołanie | ciąg | Tekst odwołania. Może to obejmować ciągi szablonu. | Tak | |
| typ | wyliczenie | Typ obiektu, który jest zawsze string_check.Możliwe wartości: string_check |
Tak |
OceniaczPodobieństwaTekstu
Obiekt TextSimilarityGrader, który klasyfikuje tekst na podstawie metryk podobieństwa.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| miara oceny | wyliczenie | Metryka oceny do użycia. Jeden z fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 lub rouge_l.Możliwe wartości: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l |
Tak | |
| dane wejściowe | ciąg | Tekst jest oceniany. | Tak | |
| nazwa | ciąg | Nazwa oceniającego. | Nie. | |
| próg zaliczenia | Liczba | Wynik zmiennoprzecinkowy, w którym wartość większa lub równa oznacza pozytywną ocenę. | Tak | |
| odwołanie | ciąg | Tekst oceniany względem. | Tak | |
| typ | wyliczenie | Typ klasyra. Możliwe wartości: text_similarity |
Tak |
Typ Wydarzenia
Definiuje ważność wyniku filtru zawartości.
| Majątek | Wartość |
|---|---|
| Opis | Definiuje ważność wyniku filtru zawartości. |
| Typ | ciąg |
| Wartości | messagemetrics |
Plik
Plik jest dokumentem, który można wykorzystać do trenowania i walidacji. Może to być również dokument wygenerowany przez usługę ze szczegółami wyników.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| B | liczba całkowita | Rozmiar tego pliku, jeśli jest dostępny (może mieć wartość null). Rozmiary plików większe niż 2^53–1 nie są obsługiwane w celu zapewnienia zgodności z liczbami całkowitymi języka JavaScript. | Nie. | |
| utworzono_o | liczba całkowita | Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix). | Nie. | |
| wygasa_o | liczba całkowita | Sygnatura czasowa systemu UNIX (liczba sekund, które upłynęły od 1 stycznia 1970 r.), gdy plik wygasł. | Nie. | |
| nazwa pliku | ciąg | Nazwa pliku. | Tak | |
| id | ciąg | Tożsamość tego elementu. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak | |
| stan | FileState | Stan pliku. | Nie. | |
| szczegóły statusu | ciąg | Komunikat o błędzie ze szczegółami w przypadku niepowodzenia przetwarzania tego pliku. Przestarzałe. | Nie. |
TworzeniePliku
Definiuje dokument do zaimportowania z adresu URL zawartości zewnętrznej, który ma być używany w usłudze Azure OpenAI.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| content_url | ciąg | Adres URL do pobrania dokumentu z witryny (może to być adres URL sygnatury dostępu współdzielonego obiektu blob lub dowolny inny zewnętrzny adres URL dostępny za pomocą żądania GET). | Tak | |
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
PlikUsuń
Definiuje odpowiedź na polecenie Usuwanie pliku.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| usunięta | typ logiczny (boolowski) | Wartość wskazująca, czy plik został usunięty. | Tak | |
| id | ciąg | Identyfikator pliku, który został usunięty. | Tak | |
| obiekt | ciąg | Jeśli plik został usunięty. | Tak |
SzczegółyPliku
Szczegóły pliku to dokument używany przez usługę wsadową w celu pobierania szczegółów blobu pliku.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| nazwa pliku | ciąg | Nazwa pliku. | Tak | |
| id | ciąg | Tożsamość tego elementu. | Nie. | |
| ścieżka | ciąg | Ścieżka względna do pliku w kontenerze. | Nie. | |
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak | |
| uri_konta_magazynowego | ciąg | Adres URL konta magazynowego tego pliku. | Nie. | |
| nazwa_pojemnika_magazynowego | ciąg | Nazwa kontenera magazynu dla tego bloba pliku. | Nie. |
PlikExpiresAfter
Definiuje wygaśnięcie pliku.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| kotwica | FileExpiryAnchor | Definiuje kotwicę względem czasu wygenerowania bezwzględnego wygaśnięcia. | Nie. | |
| Sekund | liczba całkowita | Względny czas wygaśnięcia w sekundach. Zakres: [1209600 – 2592000]. | Nie. |
FileExpiryAnchor
Definiuje kotwicę względem czasu wygenerowania bezwzględnego wygaśnięcia.
| Majątek | Wartość |
|---|---|
| Opis | Definiuje kotwicę względem czasu wygenerowania bezwzględnego wygaśnięcia. |
| Typ | ciąg |
| Wartości | created_at |
PlikImportuj
Definiuje dokument do zaimportowania z adresu URL zawartości zewnętrznej, który ma być używany w usłudze Azure OpenAI.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| content_url | ciąg | Adres URL do pobrania dokumentu z witryny (może to być adres URL sygnatury dostępu współdzielonego obiektu blob lub dowolny inny zewnętrzny adres URL dostępny za pomocą żądania GET). | Tak | |
| wygasa po | PlikExpiresAfter | Definiuje wygaśnięcie pliku. | Nie. | |
| nazwa pliku | ciąg | Nazwa pliku JSON Lines , który ma zostać przekazany. Jeśli purpose jest ustawiona na "dostrojenie", każdy wiersz jest rekordem JSON z polami "prompt" i "completion" reprezentującymi przykłady trenowania. |
Tak | |
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
Lista plików
Reprezentuje listę plików.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista elementów. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. |
Stan pliku
Stan pliku.
| Majątek | Wartość |
|---|---|
| Opis | Stan pliku. |
| Typ | ciąg |
| Wartości | uploadedpendingrunningprocessederrordeletingdeleted |
FineTuneMethod
Dyskryminator dla FineTuneMethod
Ten składnik używa właściwości type do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| typ | FineTuningMethodType | Tak |
ŻądanieMetodyFineTune
Dyskryminujące dla FineTuneMethodRequest
Ten składnik używa właściwości type do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| typ | FineTuningMethodType | Tak |
Dostrajanie hiperparametrów
Ustawienia parametrów hyper używane w zadaniu dostrajania.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rozmiar partii | liczba całkowita | Rozmiar partii do użycia do treningu. Rozmiar partii to liczba przykładów trenowania używanych do trenowania pojedynczego przebiegu do przodu i do tyłu. Ogólnie rzecz biorąc, odkryliśmy, że większe rozmiary partii zwykle działają lepiej w przypadku większych zestawów danych. Wartość domyślna, a także maksymalna wartość tej właściwości są specyficzne dla modelu podstawowego. | Nie. | |
| mnożnik szybkości uczenia | Liczba | Mnożnik szybkości nauki używany do trenowania. Współczynnik dostrajania uczenia to oryginalny współczynnik uczenia, który był używany do wstępnego trenowania, pomnożony przez tę wartość. Większe współczynniki uczenia się zwykle działają lepiej z większymi wielkościami partii. Zalecamy eksperymentowanie z wartościami z zakresu od 0,02 do 0,2, aby zobaczyć, co daje najlepsze wyniki. | Nie. | |
| n_epochs (liczba epok) | liczba całkowita | Liczba epok treningu dla modelu. Epoka odnosi się do jednego pełnego cyklu przez zestaw danych szkoleniowych. | Nie. |
Zadanie dostrajania
Definiuje wartości zadania dokładnego dostrajania.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix). | Nie. | |
| błąd | FineTuningJobError | W przypadku zadań dostrajania, które zakończyły się niepowodzeniem, będzie to zawierać więcej informacji na temat przyczyny awarii. | Nie. | |
| szacowany czas zakończenia | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) dla momentu zakończenia zadania dostrajania. Wartość będzie równa null, jeśli zadanie dopasowywania nie jest uruchomione. | Nie. | |
| model dostrojony | ciąg | Identyfikator (model-id) wynikowego, dostosowanego modelu. Ta właściwość jest wypełniana tylko w przypadku pomyślnie ukończonych procesów dostrajania. Użyj tego identyfikatora, aby utworzyć wdrożenie na potrzeby wnioskowania. | Nie. | |
| zakończono_o | liczba całkowita | Sygnatura czasowa pomyślnego zakończenia tego zadania lub elementu (w epokach unix). | Nie. | |
| hiperparametry | FineTuningHyperParameters | Ustawienia parametrów hyper używane w zadaniu dostrajania. | Nie. | |
| id | ciąg | Tożsamość tego elementu. | Nie. | |
| Integracje | macierz | Lista konfiguracji integracji obsługujących zadanie dostrajania. Zaplanowano wiele integracji, dlatego upewnij się, że sprawdzasz typ integracji i działasz na nim. | Nie. | |
| metoda | obiekt | Metoda używana do nadzorowanego dostrajania | Nie. | |
| └typ | FineTuningMethodType | Nie. | ||
| model | ciąg | Identyfikator (model-id) modelu podstawowego używanego do dostosowania. | Tak | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| identyfikator_organizacji | ciąg | Identyfikator organizacji tego zadania dostrajania. Nieużywane w usłudze Azure OpenAI; zgodność tylko z funkcją OpenAI. | Nie. | |
| pliki_wynikowe | macierz | Tożsamości plików wynikowych (file-id) zawierające metryki trenowania i oceny w formacie csv. Plik jest dostępny tylko w przypadku pomyślnie ukończonych przebiegów dostrajania. | Nie. | |
| nasienie | liczba całkowita | Nasiono używane do działania dostrajania. | Nie. | |
| stan | FineTuningState | Stan obiektu dostrajania lub zadania dostrajania. | Nie. | |
| przyrostek | ciąg | Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9, - i _), które zostaną dodane do dostosowanej nazwy modelu. | Nie. | |
| tokeny szkoleniowe | liczba całkowita | Łączna liczba rozliczanych tokenów przetworzonych przez to zadanie dostrajania. | Nie. | |
| plik szkoleniowy | ciąg | Plik, który jest używany do trenowania. | Tak | |
| plik walidacji | ciąg | Plik, który jest używany do oceny dobrze dostosowanego modelu podczas trenowania. | Nie. |
Punkt Kontrolny Dostosowania Pracy
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia punktu kontrolnego. | Tak | |
| punkt kontrolny modelu dostrojonego | ciąg | Nazwa utworzonego modelu punktów kontrolnych. | Tak | |
| identyfikator_zadania_dostrajania | ciąg | Nazwa zadania dostrajania, na podstawie którego utworzono ten punkt kontrolny. | Tak | |
| id | ciąg | Tożsamość tego punktu kontrolnego. | Nie. | |
| metryki | obiekt | Metryki w numerze kroku podczas zadania dostrajania. | Tak | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| numer_kroku | liczba całkowita | Numer kroku, na który został utworzony punkt kontrolny. | Tak |
Lista Punktów Kontrolnych Zadań Dostosowywania
Reprezentuje listę punktów kontrolnych.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista elementów. | Nie. | |
| zawiera_więcej | typ logiczny (boolowski) | Wartość wskazująca, czy lista zawiera więcej elementów niż zwracane. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. |
FineTuningJobCreation
Definiuje wartości zadania dokładnego dostrajania.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| hiperparametry | FineTuningHyperParameters | Ustawienia parametrów hyper używane w zadaniu dostrajania. | Nie. | |
| Integracje | macierz | Lista konfiguracji integracji obsługujących zadanie dostrajania. Zaplanowano wiele integracji, dlatego upewnij się, że sprawdzasz typ integracji i działasz na nim. | Nie. | |
| metoda | obiekt | Metoda używana do nadzorowanego dostrajania | Nie. | |
| └typ | FineTuningMethodType | Nie. | ||
| model | ciąg | Identyfikator (model-id) modelu podstawowego używanego na potrzeby tej precyzyjnej melodii. | Tak | |
| nasienie | liczba całkowita | Nasiono używane do działania dostrajania. Przekazywanie tych samych parametrów nasion i zadania powinno generować te same wyniki, ale mogą się różnić w rzadkich przypadkach. Jeśli nasion nie zostanie określony, zostanie wygenerowany dla Ciebie. | Nie. | |
| przyrostek | ciąg | Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9, - i _), które zostaną dodane do dostosowanej nazwy modelu. | Nie. | |
| plik szkoleniowy | ciąg | Tożsamość pliku (identyfikator pliku), która jest używana do trenowania tego dobrze dostosowanego modelu. | Tak | |
| plik walidacji | ciąg | Tożsamość pliku (identyfikator pliku), która jest używana do oceny dobrze dostosowanego modelu podczas trenowania. | Nie. |
FineTuningJobError
W przypadku zadań dostrajania, które zakończyły się niepowodzeniem, będzie to zawierać więcej informacji na temat przyczyny awarii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| kod | ciąg | Kod błędu czytelny dla maszyny. | Nie. | |
| komunikat | ciąg | Czytelny dla człowieka komunikat o błędzie. | Nie. | |
| Param | ciąg | Parametr, który był nieprawidłowy, zwykle training_file lub validation_file. To pole będzie miało wartość null, jeśli błąd nie był specyficzny dla parametru. | Nie. |
ZdarzenieDostosowywaniaPracy
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Sygnatura czasowa utworzenia tego zdarzenia (w epokach unix). | Tak | |
| dane | Dane z możliwością odczytu maszyny tego zdarzenia. | Nie. | ||
| id | ciąg | Tożsamość tego zdarzenia. | Nie. | |
| poziom | PoziomLogu | Poziom szczegółowości zdarzenia. | Tak | |
| komunikat | ciąg | Komunikat opisujący zdarzenie. Może to być zmiana stanu, np. w kolejce, uruchomiona, zakończona lub zakończona albo inne zdarzenia, takie jak przekazane wyniki. | Tak | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| typ | EventType | Definiuje ważność wyniku filtru zawartości. | Tak |
Lista Zdarzeń Zadania FineTuning
Reprezentuje listę zdarzeń.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista elementów. | Nie. | |
| zawiera_więcej | typ logiczny (boolowski) | Wartość wskazująca, czy lista zawiera więcej elementów niż zwracane. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. |
FineTuningJobList
Reprezentuje listę drobnych melodii.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista elementów. | Nie. | |
| zawiera_więcej | typ logiczny (boolowski) | Wartość wskazująca, czy lista zawiera więcej elementów niż zwracane. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. |
TypMetodyDostrajania
| Majątek | Wartość |
|---|---|
| Typ | ciąg |
| Wartości | dposupervised |
FineTuningState
Stan obiektu dostrajania lub zadania dostrajania.
| Majątek | Wartość |
|---|---|
| Opis | Stan obiektu dostrajania lub zadania dostrajania. |
| Typ | ciąg |
| Wartości | createdpendingrunningpausingpausedresumingsucceededcancelledfailed |
FunkcjaWywołaniaFunkcji
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Argumenty | ciąg | Argumenty, które model oczekuje przekazania do funkcji. | Nie. | |
| nazwa | ciąg | Nazwa funkcji. | Nie. |
FunkcjaDefinition
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| opis | ciąg | Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję. | Nie. | |
| nazwa | ciąg | Nazwa funkcji do wywołania. | Nie. | |
| Parametry | Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. | Nie. |
UstawieniaOsadzeńTypowych
Ustawienia osadzania połączenia
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| połączenie | Połączenie podstawowe | Połączenie z zasobem. | Nie. | |
| NazwaWdrożenia | ciąg | Nie. | ||
| nazwa_modelu | ciąg | Nie. |
Błąd przetwarzania
Szczegóły błędu pozyskiwania
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| błędy wewnętrzne | macierz | Nie. | ||
| komunikat | ciąg | Nie. |
IngestionJob
Reprezentuje szczegóły zadania.
Rozróżniacz dla IngestionJob
Ten składnik używa właściwości kind do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| ID zadania | ciąg | Nie. | ||
| rodzaj | IngestionJobType | Typ zadania. | Tak |
IngestionJobList
Reprezentuje listę zadań pozyskiwania.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| nextLink | ciąg | Link do następnej strony. | Nie. | |
| wartość | macierz | Lista elementów. | Nie. |
Postęp zadania importu danych
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| stageProgress | macierz | Tak |
IngestionJobRun
Szczegóły uruchomienia zadania
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| błąd | IngestionError | Szczegóły błędu pozyskiwania | Nie. | |
| ID zadania | ciąg | Nie. | ||
| postęp | IngestionJobProgress | Nie. | ||
| identyfikator uruchomienia | ciąg | Nie. | ||
| stan | OperationState | Stan zadania lub elementu. | Nie. | |
| Ostrzeżenia | macierz | Nie. |
ListaUruchomieńZadańPobieraniaDanych
Lista uruchomień zadań pozyskiwania danych.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| nextLink | ciąg | Link do następnej strony. | Nie. | |
| wartość | macierz | Lista elementów. | Nie. |
IngestionJobStageProgress
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| nazwa | ciąg | Nie. | ||
| przetworzone elementy | liczba całkowita | Nie. | ||
| stan | OperationState | Stan zadania lub elementu. | Nie. | |
| subStageProgress | macierz | Nie. | ||
| Łączna liczba elementów | liczba całkowita | Nie. |
IngestionJobSystemCompute
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| akcja ukończenia | Zakończenieakcja | Akcja ukończenia. | Nie. | |
| interwałOdświeżaniaDanychWGodzinach | liczba całkowita | Nie. | ||
| źródło danych | SystemComputeDatasource | Nie. | ||
| ID zadania | ciąg | Nie. | ||
| rodzaj | IngestionJobType | Typ zadania. | Tak | |
| searchServiceConnection | Połączenie podstawowe | Połączenie z zasobem. | Nie. |
TypZadaniaIngestji
Typ zadania.
| Majątek | Wartość |
|---|---|
| Opis | Typ zadania. |
| Typ | ciąg |
| Wartości | SystemComputeUserCompute |
ZadanieImportowaniaDanychUżytkownikaObliczeniowych
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| obliczanie | Zadanie-Compute | Ustawienia obliczeniowe zadania. | Nie. | |
| interwałOdświeżaniaDanychWGodzinach | liczba całkowita | Nie. | ||
| źródło danych | UserComputeDatasource | Nie. | ||
| ID zadania | ciąg | Nie. | ||
| rodzaj | IngestionJobType | Typ zadania. | Tak | |
| miejsce docelowe | TargetIndex | Informacje o indeksie do utworzenia. | Nie. | |
| Identyfikator przestrzeni roboczej (workspaceId) | ciąg | Nie. |
InnerError
Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| kod | InnerErrorCode | Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft. | Nie. | |
innererror |
InnerError | Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft. | Nie. |
WewnętrznyKodBłędu
Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft.
| Majątek | Wartość |
|---|---|
| Opis | Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft. |
| Typ | ciąg |
| Wartości | invalidPayload |
WiadomośćWejściowa
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| zawartość | ciąg | Zawartość wiadomości. | Nie. | |
| id | ciąg | Tożsamość wiadomości. | Nie. | |
| nazwa | ciąg | Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli. | Nie. | |
| rola | ciąg | Rola jednostki tworzącej komunikat. | Nie. |
InputTextContent
Wprowadzanie tekstu do modelu.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| SMS | ciąg | Wprowadzanie tekstu do modelu. | Tak | |
| typ | wyliczenie | Typ elementu wejściowego. Zawsze input_text.Możliwe wartości: input_text |
Tak |
Typy integracji
Lista dostępnych integracji precyzyjnego dostrajania.
| Majątek | Wartość |
|---|---|
| Opis | Lista dostępnych integracji precyzyjnego dostrajania. |
| Typ | ciąg |
| Wartości | wandb |
ZadanieCompute
Ustawienia obliczeniowe zadania.
Dyskryminujący dla zadaniaCompute
Ten składnik używa właściwości kind do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rodzaj | Typ obliczeniowy | Typ obliczeniowy. | Tak |
LifeCycleStatus
Stan cyklu życia modelu.
Uwaga: model może być promowany z preview do generally-available, ale nigdy z generally-available do preview.
| Majątek | Wartość |
|---|---|
| Opis | Stan cyklu życia modelu. Uwaga: model może być promowany z preview do generally-available, ale nigdy z generally-available do preview. |
| Typ | ciąg |
| Wartości | previewgenerally-availabledeprecatingdeprecated |
Poziom Logowania
Poziom szczegółowości zdarzenia.
| Majątek | Wartość |
|---|---|
| Opis | Poziom szczegółowości zdarzenia. |
| Typ | ciąg |
| Wartości | infowarningerror |
Logprob
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| logprob | Liczba | Prawdopodobieństwo dziennika tego tokenu, jeśli znajduje się on w pierwszych 20 najbardziej prawdopodobnych tokenach. W przeciwnym razie wartość -9999.0 jest używana do oznaczania, że token jest bardzo mało prawdopodobny. |
Nie. | |
| kod przedpłaty | ciąg | Znacznik. | Nie. |
Metadane
Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.
Brak zdefiniowanych właściwości dla tego składnika.
Model
Model jest albo modelem podstawowym, albo wynikiem pomyślnego procesu dostrajania.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| możliwości | Możliwości | Możliwości modelu podstawowego lub precyzyjnego dostrajania. | Tak | |
| utworzono_o | liczba całkowita | Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix). | Nie. | |
| Wycofanie | Przestarzałość | Definiuje daty wycofania dla różnych przypadków użycia modelu. Zazwyczaj modele podstawowe umożliwiają dostrajanie na okres 1 roku po ich utworzeniu, natomiast wnioskowanie jest zwykle wspierane przez 2 lata od momentu utworzenia modeli podstawowych lub dostrojonych. Dokładne daty są określone we właściwościach. | Tak | |
| fine_tune | ciąg | Tożsamość zadania dostrajania (fine-tune-id), jeśli jest to odpowiedni model dostrajania; w przeciwnym razie null. |
Nie. | |
| id | ciąg | Tożsamość tego elementu. | Nie. | |
| status_cyklu_życia | LifeCycleStatus | Stan cyklu życia modelu. Uwaga: model może być promowany z "wersji zapoznawczej" do generally-available, ale nigdy nie z generally-available "wersji zapoznawczej". |
Tak | |
| model | ciąg | Tożsamość modelu podstawowego (model-id), jeśli jest to odpowiedni model dostrajania; w przeciwnym razie null. |
Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| stan | FineTuningState | Stan obiektu dostrajania lub zadania dostrajania. | Nie. |
Lista modeli
Reprezentuje listę modeli.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista elementów. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. |
OperationState
Stan zadania lub elementu.
| Majątek | Wartość |
|---|---|
| Opis | Stan zadania lub elementu. |
| Typ | ciąg |
| Wartości | notRunningrunningsucceededfailed |
Zamówienie
Definiuje przeznaczenie pliku.
| Majątek | Wartość |
|---|---|
| Opis | Definiuje przeznaczenie pliku. |
| Typ | ciąg |
| Wartości | descasc |
ZamówieniePoZamówieniu
| Majątek | Wartość |
|---|---|
| Typ | ciąg |
| Wartości | ascdesc |
PineconeIndex
Indeks Pinecone.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| identyfikator połączenia | ciąg | Identyfikator połączenia wskazującego na pinecone. | Nie. | |
| rodzaj | TargetType | Typ docelowy. | Tak |
Przeznaczenie
Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku.
| Majątek | Wartość |
|---|---|
| Opis | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. |
| Typ | ciąg |
| Wartości | fine-tunefine-tune-resultsassistantsassistants_outputbatchbatch_outputevalsevals_output |
Bezserwerowacompute
Bezserwerowe obliczenia.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| instanceCount (liczba wystąpień) | liczba całkowita | Liczba wystąpień do uruchomienia zadania. | Nie. | |
| rodzaj | Typ obliczeniowy | Typ obliczeniowy. | Tak | |
| Jednostka magazynowa (SKU) | ciąg | Poziom jednostki SKU | Nie. |
Składowanacompletion
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Wyborów | macierz | Lista opcji ukończenia czatu. Może być więcej niż jeden, jeśli n jest większy niż 1. |
Nie. | |
| utworzone | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) wskazująca moment utworzenia zakończenia czatu. | Nie. | |
| kara za częstotliwość | Liczba | Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzeją nowe tokeny na podstawie ich istniejącej częstotliwości w tekście do tej pory, zmniejszając prawdopodobieństwo powtórzeń tego samego wiersza. | Nie. | |
| id | ciąg | Tożsamość przechowywanego uzupełniania. | Nie. | |
| wprowadź_użytkownika | ciąg | Wejściowy użytkownik dla tego żądania. | Nie. | |
| metadane | obiekt | Aby uzyskać dodatkowe informacje, należy uzyskać dowolne pary klucz-wartość. | Nie. | |
| model | ciąg | Identyfikator modelu do użycia. | Nie. | |
| kara_obecności | Liczba | Liczba z zakresu od -2.0 do 2.0. Dodatnie wartości nakładają karę na nowe tokeny na podstawie tego, czy pojawiają się one w tekście do tej pory, zwiększając prawdopodobieństwo, że model zacznie poruszać nowe tematy. | Nie. | |
| identyfikator_żądania | ciąg | Unikatowy identyfikator żądania API OpenAI. Dołącz ten identyfikator żądania podczas kontaktowania się z pomocą techniczną. | Nie. | |
| nasienie | liczba całkowita | Jeśli zostanie określony, nasz system podejmie najlepsze wysiłki, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do |
||
system_fingerprint parametr odpowiedzi do monitorowania zmian w backendzie. |
Nie. | |||
| poziom usługi | ciąg | Określa warstwę opóźnienia, która ma być używana do przetwarzania żądania. | Nie. | |
| systemowy odcisk palca | ciąg | Ten odcisk palca reprezentuje zaplecze systemowe, z którym działa model. Można użyć w połączeniu z parametrem żądania seed, aby zrozumieć, kiedy wprowadzono zmiany w back-endzie, które mogą wpływać na deterministyczne działanie. |
Nie. | |
| temperatura | Liczba | Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie. |
Nie. | |
| wybór narzędzia | ciąg | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. | Nie. | |
| narzędzia | macierz | Lista narzędzi, które model może wywołać. Obecnie tylko funkcje są obsługiwane jako narzędzie. Służy do udostępniania listy funkcji, dla których model może generować dane wejściowe JSON. Obsługiwane są maksymalnie 128 funkcji. | Nie. | |
| top_p | Liczba | Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie. |
Nie. | |
| użycie | Użycie | Nie. |
UsunięcieZakończeniaPrzechowanego
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| usunięta | typ logiczny (boolowski) | Wartość wskazująca, czy ma miejsce usunięcie przechowywanego ukończenia. | Nie. | |
| id | ciąg | Przechowywany identyfikator ukończenia, który został usunięty. | Nie. | |
| obiekt | ciąg | Jeśli przechowywane uzupełnianie zostało usunięte. | Tak |
PrzechowywanaListaUkończeń
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista pobranych obiektów. | Nie. | |
| first_id | ciąg | Pierwszy identyfikator pobranego list |
Nie. | |
| zawiera_więcej | typ logiczny (boolowski) | Właściwość has_more służy do stronicowania, aby wskazać, że istnieją dodatkowe wyniki. |
Nie. | |
| last_id | ciąg | Ostatni identyfikator pobranego list |
Nie. | |
| obiekt | ciąg | Typ obiektu, który jest zawsze list |
Nie. | |
| łączny | liczba całkowita | Całkowita liczba elementów. | Nie. |
PrzechowywaneWiadomościZakończenia
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista pobranych obiektów. | Nie. | |
| first_id | ciąg | Pierwszy identyfikator pobranego list |
Nie. | |
| zawiera_więcej | typ logiczny (boolowski) | Właściwość has_more służy do stronicowania, aby wskazać, że istnieją dodatkowe wyniki. |
Nie. | |
| last_id | ciąg | Ostatni identyfikator pobranego list |
Nie. | |
| obiekt | ciąg | Typ obiektu, który jest zawsze list |
Nie. | |
| łączny | liczba całkowita | Całkowita liczba elementów. | Nie. |
ZapisanaOdpowiedźKompletacji
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Wyborów | macierz | Lista opcji ukończenia czatu. Może być więcej niż jeden, jeśli n jest większy niż 1. |
Nie. | |
| utworzone | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) wskazująca moment utworzenia zakończenia czatu. | Nie. | |
| kara za częstotliwość | Liczba | Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzeją nowe tokeny na podstawie ich istniejącej częstotliwości w tekście do tej pory, zmniejszając prawdopodobieństwo powtórzeń tego samego wiersza. | Nie. | |
| id | ciąg | Tożsamość przechowywanego uzupełniania. | Nie. | |
| wprowadź_użytkownika | ciąg | Wejściowy użytkownik dla tego żądania. | Nie. | |
| metadane | obiekt | Aby uzyskać dodatkowe informacje, należy uzyskać dowolne pary klucz-wartość. | Nie. | |
| model | ciąg | Identyfikator modelu do użycia. | Nie. | |
| obiekt | ciąg | Typ tego obiektu. | Nie. | |
| kara_obecności | Liczba | Liczba z zakresu od -2.0 do 2.0. Dodatnie wartości nakładają karę na nowe tokeny na podstawie tego, czy pojawiają się one w tekście do tej pory, zwiększając prawdopodobieństwo, że model zacznie poruszać nowe tematy. | Nie. | |
| identyfikator_żądania | ciąg | Unikatowy identyfikator żądania API OpenAI. Dołącz ten identyfikator żądania podczas kontaktowania się z pomocą techniczną. | Nie. | |
| nasienie | liczba całkowita | Jeśli zostanie określony, nasz system podejmie najlepsze wysiłki, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seedparametrami zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru odpowiedzi system_fingerprint w celu monitorowania zmian na serwerze. |
Nie. | |
| poziom usługi | ciąg | Określa warstwę opóźnienia, która ma być używana do przetwarzania żądania. | Nie. | |
| systemowy odcisk palca | ciąg | Ten odcisk palca reprezentuje zaplecze systemowe, z którym działa model. Można użyć w połączeniu z parametrem żądania seed, aby zrozumieć, kiedy wprowadzono zmiany w back-endzie, które mogą wpływać na deterministyczne działanie. |
Nie. | |
| temperatura | Liczba | Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie. |
Nie. | |
| wybór narzędzia | ciąg | Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. | Nie. | |
| narzędzia | macierz | Lista narzędzi, które model może wywołać. Obecnie tylko funkcje są obsługiwane jako narzędzie. Służy do udostępniania listy funkcji, dla których model może generować dane wejściowe JSON. Obsługiwane są maksymalnie 128 funkcji. | Nie. | |
| top_p | Liczba | Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie. |
Nie. | |
| użycie | Użycie | Nie. |
Metoda Nadzorowana
Metoda używana do nadzorowanego dostrajania
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| typ | FineTuningMethodType | Tak |
ŻądanieMetodyNadzorowanej
Metoda używana do nadzorowanego dostrajania
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| typ | FineTuningMethodType | Tak |
SystemComputeDatasource
Dyskryminujące dla elementu SystemComputeDatasource
Ten składnik używa właściwości kind do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rodzaj | SystemComputeDatasourceType | Typ źródła danych. | Tak |
SystemObliczeniowyTypŹródłaDanych
Typ źródła danych.
| Majątek | Wartość |
|---|---|
| Opis | Typ źródła danych. |
| Typ | ciąg |
| Wartości | StorageUrls |
SystemComputeStorage
Konto magazynu
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Segmentu | Ustawienia dzielenia na segmenty (ChunkingSettings) | Ustawienia fragmentowania | Nie. | |
| połączenie | Połączenie podstawowe | Połączenie z zasobem. | Nie. | |
| nazwaKontenera | ciąg | nazwa kontenera | Nie. | |
| osadzanie | macierz | Nie. | ||
| rodzaj | SystemComputeDatasourceType | Typ źródła danych. | Tak |
SystemComputeUrl
Adresy URL
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Segmentu | Ustawienia dzielenia na segmenty (ChunkingSettings) | Ustawienia fragmentowania | Nie. | |
| połączenie | Połączenie podstawowe | Połączenie z zasobem. | Nie. | |
| nazwaKontenera | ciąg | nazwa kontenera | Nie. | |
| śledzenie | UstawieniaPrzeszukiwania | Ustawienia przeszukiwania | Nie. | |
| osadzanie | macierz | Nie. | ||
| rodzaj | SystemComputeDatasourceType | Typ źródła danych. | Tak | |
| adresy URL | macierz | Nie. |
Indeks Docelowy
Informacje o indeksie do utworzenia.
Dyskryminator dla TargetIndex
Ten składnik używa właściwości kind do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rodzaj | TargetType | Typ docelowy. | Tak |
TypDocelowy
Typ docelowy.
| Majątek | Wartość |
|---|---|
| Opis | Typ docelowy. |
| Typ | ciąg |
| Wartości | AzureAISearchCosmosDBPinecone |
Narzędzie
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| funkcja | FunkcjaDefinition | Nie. | ||
| typ | ciąg | Typ wywołania narzędzia. To zawsze będzie function dotyczyć tego typu wywołania narzędzia. |
Nie. |
ToolCall
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| funkcja | FunctionCallFunction | Nie. | ||
| id | ciąg | Identyfikator wywołania narzędzia. | Nie. | |
| typ | ciąg | Typ narzędzia wywołującego dane wyjściowe jest wymagany. Na razie jest to zawsze function. |
Nie. |
RozróżniaczTypu
Definiuje typ obiektu.
| Majątek | Wartość |
|---|---|
| Opis | Definiuje typ obiektu. |
| Typ | ciąg |
| Wartości | listfine_tuning.jobfilefine_tuning.job.eventfine_tuning.job.checkpointmodeluploadupload.partbatchwandb |
ZaktualizujPrzechowywaneŻądanieUkończenia
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| metadane | obiekt | Aby uzyskać dodatkowe informacje, należy uzyskać dowolne pary klucz-wartość. | Nie. |
UploadFileCompleteBody
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| md5 | ciąg | Nie. | ||
| part_ids | macierz | Tak |
UploadFileStartBody
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| B | liczba całkowita | Tak | ||
| nazwa pliku | ciąg | Tak | ||
| typ MIME | ciąg | Tak | ||
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Tak |
UploadPartResource
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| azure_block_id (identyfikator bloku Azure) | ciąg | Nie. | ||
| utworzono_o | liczba całkowita | Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix). | Nie. | |
| id | ciąg | Tożsamość tego elementu. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| identyfikator_uploadu | ciąg | Nie. |
UploadResource
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| B | liczba całkowita | Nie. | ||
| utworzono_o | liczba całkowita | Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix). | Nie. | |
| wygasa_o | liczba całkowita | Nie. | ||
| plik | Plik | Plik jest dokumentem, który można wykorzystać do trenowania i walidacji. Może to być również dokument wygenerowany przez usługę ze szczegółami wyników. | Nie. | |
| nazwa pliku | ciąg | Nie. | ||
| id | ciąg | Tożsamość tego elementu. | Nie. | |
| obiekt | TypeDiscriminator | Definiuje typ obiektu. | Nie. | |
| cel | Przeznaczenie | Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku. | Nie. | |
| stan | UploadStatus | Nie. |
Status przesyłania
| Majątek | Wartość |
|---|---|
| Typ | ciąg |
| Wartości | pendingexpiredcompletedcancelled |
Zastosowanie
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| tokeny_zakończenia | liczba całkowita | Liczba tokenów w wygenerowanym zakończeniu. | Nie. | |
| tokeny_wywołania | liczba całkowita | Liczba tokenów w prompt. | Nie. | |
| suma_znaczniki | liczba całkowita | Łączna liczba tokenów użytych w żądaniu (zapytanie + ukończenie). | Nie. |
ZbiórDanychObliczeniowyUżytkownika
Konto magazynu
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Segmentu | Ustawienia dzielenia na segmenty (ChunkingSettings) | Ustawienia fragmentowania | Nie. | |
| datasetId | ciąg | Nie. | ||
| typ zestawu danych | ciąg | Nie. | ||
| osadzanie | macierz | Nie. | ||
| rodzaj | TypŹródłaDanychUżytkownikaCompute | Typ źródła danych. | Tak |
ŹródłoDanychObliczeniowychUżytkownika
Dyskryminator dla UserComputeDatasource
Ten składnik używa właściwości kind do rozróżniania różnych typów:
| Wartość typu | Schemat |
|---|
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| rodzaj | TypŹródłaDanychUżytkownikaCompute | Typ źródła danych. | Tak |
TypŹródłaDanychUżytkownikaObliczeniowego
Typ źródła danych.
| Majątek | Wartość |
|---|---|
| Opis | Typ źródła danych. |
| Typ | ciąg |
| Wartości | DatasetUrls |
UserComputeUrl
Adresy URL
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| Segmentu | Ustawienia dzielenia na segmenty (ChunkingSettings) | Ustawienia fragmentowania | Nie. | |
| śledzenie | UstawieniaPrzeszukiwania | Ustawienia przeszukiwania | Nie. | |
| osadzanie | macierz | Nie. | ||
| rodzaj | TypŹródłaDanychUżytkownikaCompute | Typ źródła danych. | Tak | |
| adresy URL | macierz | Nie. |
Żądanie Integracji WandB
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| jednostka | ciąg | Nie. | ||
| nazwa | ciąg | Nie. | ||
| projekt | ciąg | Tak | ||
| Etykiety | macierz | Nie. |
WandBIntegrationRequestWrapper
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| typ | IntegrationTypes | Lista dostępnych integracji precyzyjnego dostrajania. | Tak | |
| różdżka | WandBIntegrationRequest | Tak |
Obszar roboczyPołączenie
Połączenie obszaru roboczego AML.
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| identyfikator połączenia | ciąg | Identyfikator połączenia | Nie. | |
| rodzaj | Typ połączenia | Typ połączenia. | Tak |
Ustawienia osadzania połączenia w przestrzeni roboczej
Identyfikator połączenia z modelem osadzania
| Nazwa | Typ | Opis | Wymagane | Wartość domyślna |
|---|---|---|---|---|
| identyfikator połączenia | ciąg | Nie. | ||
| NazwaWdrożenia | ciąg | Nie. | ||
| nazwa_modelu | ciąg | Nie. |
Dalsze kroki
Dowiedz się więcej o modelach i dostrajaniu za pomocą interfejsu API REST. Dowiedz się więcej o modelach bazowych, które zasilają usługę Azure OpenAI.