Azure OpenAI
Łatwe integrowanie Azure najnowocześniejszych możliwości sztucznej inteligencji openAI w przepływach pracy
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Premium | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Microsoft |
| adres URL | https://support.microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://azure.microsoft.com/en-us/products/cognitive-services/openai-service |
| Zasady ochrony prywatności | https://learn.microsoft.com/en-us/legal/cognitive-services/openai/data-privacy |
| Kategorie | AI; Analiza biznesowa |
Azure OpenAI On Your Data umożliwia uruchamianie zaawansowanych modeli sztucznej inteligencji, takich jak GPT-35-Turbo i GPT-4, na własnych danych przedsiębiorstwa bez konieczności trenowania lub dostosowywania modeli. Możesz rozmawiać na bieżąco i analizować dane z większą dokładnością. Możesz również określić źródła do obsługi odpowiedzi modelu na podstawie najnowszych informacji dostępnych w wyznaczonych źródłach danych lub pominąć źródło danych w celu wywołania modelu Azure OpenAI bez uziemienia danych.
Wymagania wstępne
- Azure subskrypcji — Utwórz ją bezpłatnie.
-
Apply aby uzyskać dostęp do Azure OpenAI. Azure interfejs OpenAI wymaga rejestracji i jest obecnie dostępny tylko dla zatwierdzonych klientów korporacyjnych i partnerów. Aby uzyskać więcej informacji zobacz Ograniczony dostęp do
Azure OpenAI Service. -
Tworzenie zasobu Azure OpenAI w portalu Azure. Pamiętaj, aby utworzyć zasób w obsługiwanym regionie z obsługiwanym modelem.
- Upewnij się, że masz przypisaną co najmniej rolę Cognitive Services Contributor dla zasobu Azure OpenAI.
- Utwórz zasób Wyszukiwanie AI platformy Azure w portalu Azure i postępuj zgodnie z best practices do przygotowywania danych w wystąpieniu Wyszukiwanie AI platformy Azure do użycia z usługą Azure OpenAI On Your Data Service.
Wskazówka
Jeśli po raz pierwszy używasz Azure OpenAI On Your Data, wypróbuj quickstart, aby rozpocząć pracę z usługą.
Pobieranie poświadczeń
Aby uwierzytelnić żądania interfejsu API, musisz mieć klucz i punkt końcowy dla zasobów Azure OpenAI i Wyszukiwanie AI platformy Azure.
Dla zasobu Azure OpenAI:
- Przejdź do zasobu w portalu Azure.
- Na stronie zasobu wybierz pozycję Klucze i punkt końcowy w menu nawigacji po lewej stronie. Zanotuj swoje poświadczenia. Użyjesz jednego z kluczy i punktu końcowego.
Dla zasobu Wyszukiwanie AI platformy Azure:
- Przejdź do zasobu w portalu Azure.
- Na stronie Przegląd zasobu zanotuj adres URL.
- Wybierz pozycję Klucze w menu nawigacji po lewej stronie. Użyjesz jednego z kluczy administratora.
Znane problemy i ograniczenia
- Tylko Wyszukiwanie AI platformy Azure jest obsługiwana jako źródło danych do używania Azure OpenAI na danych za pomocą tego łącznika platformy Power Platform.
- Wywoływanie funkcji nie jest obsługiwane.
- Obrazy nie są obsługiwane w zawartości wiadomości.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Klucz API | Podaj Azure nazwę zasobu OpenAI i klucz interfejsu API, aby uzyskać dostęp do Azure openAI hostujących model AI. | Wszystkie regiony | Udostępnialne |
| Tożsamość zarządzana | Tworzenie połączenia przy użyciu tożsamości zarządzanej | Tylko USŁUGA LOGICAPPS | Udostępnialne |
| integracja Microsoft Entra ID | Użyj Microsoft Entra ID, aby uzyskać dostęp do Azure OpenAI. Każdy użytkownik łączący musi mieć rolę użytkownika OpenAI usług Cognitive Services w zasobie Azure OpenAI. | Wszystkie regiony | Nie można udostępniać |
| Domyślne [PRZESTARZAŁE] | Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. | Wszystkie regiony | Nie można udostępniać |
Klucz interfejsu API
Identyfikator uwierzytelniania: keyBasedAuth
Dotyczy: wszystkie regiony
Podaj Azure nazwę zasobu OpenAI i klucz interfejsu API, aby uzyskać dostęp do Azure openAI hostujących model AI.
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz omówienie Connectors dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Azure nazwa zasobu OpenAI | ciąg | Nazwa zasobu Azure OpenAI, który hostuje model AI | Prawda |
| Azure klucz interfejsu API openAI | securestring | Klucz interfejsu API umożliwiający dostęp do zasobu Azure OpenAI hostujący model AI | Prawda |
| adres URL punktu końcowego Azure Cognitive Search | ciąg | Adres URL punktu końcowego Azure Cognitive Search indeksowania danych | |
| klucz interfejsu API Azure Cognitive Search | securestring | Klucz interfejsu API umożliwiający dostęp do Azure Cognitive Search punktu końcowego indeksowania danych |
Zarządzana Tożsamość
Identyfikator uwierzytelniania: managedIdentityAuth
Dotyczy: tylko USŁUGA LOGICAPPS
Tworzenie połączenia przy użyciu tożsamości zarządzanej
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz omówienie Connectors dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Zarządzana Tożsamość | managedIdentity | Logowanie przy użyciu tożsamości zarządzanej | Prawda |
| Azure nazwa zasobu OpenAI | ciąg | Nazwa zasobu Azure OpenAI, który hostuje model AI | Prawda |
Zintegrowana usługa Microsoft Entra ID
Identyfikator uwierzytelniania: oauth
Dotyczy: wszystkie regiony
Użyj Microsoft Entra ID, aby uzyskać dostęp do Azure OpenAI. Każdy użytkownik łączący musi mieć rolę użytkownika OpenAI usług Cognitive Services w zasobie Azure OpenAI.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Azure nazwa zasobu OpenAI | ciąg | Nazwa zasobu Azure OpenAI, który hostuje model AI | Prawda |
Domyślne [PRZESTARZAŁE]
Dotyczy: wszystkie regiony
Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Azure nazwa zasobu OpenAI | ciąg | Nazwa zasobu Azure OpenAI, który hostuje model AI | Prawda |
| Azure klucz interfejsu API openAI | securestring | Klucz interfejsu API umożliwiający dostęp do zasobu Azure OpenAI hostujący model AI | Prawda |
| adres URL punktu końcowego Azure Cognitive Search | ciąg | Adres URL punktu końcowego Azure Cognitive Search indeksowania danych | |
| klucz interfejsu API Azure Cognitive Search | securestring | Klucz interfejsu API umożliwiający dostęp do Azure Cognitive Search punktu końcowego indeksowania danych |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 1000 | 60 sekund |
Akcje
| Pobieranie osadzania |
Uzyskiwanie wektorowej reprezentacji danych wejściowych, które mogą być łatwo używane przez modele i algorytmy uczenia maszynowego |
| Pobieranie wielu osadzania |
Uzyskiwanie reprezentacji wektorów dla danej tablicy danych wejściowych, które mogą być łatwo używane przez modele i algorytmy uczenia maszynowego |
| Tworzenie uzupełniania wiadomości czatu przy użyciu rozszerzeń |
Tworzenie uzupełniania wiadomości czatu przy użyciu rozszerzeń |
| Tworzy uzupełnienie wiadomości na czacie |
Tworzy uzupełnienie wiadomości na czacie |
Pobieranie osadzania
Uzyskiwanie wektorowej reprezentacji danych wejściowych, które mogą być łatwo używane przez modele i algorytmy uczenia maszynowego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wdrożenia wdrożonego modelu
|
deployment-id | True | string |
Identyfikator wdrożenia wdrożonego modelu |
|
wersja API
|
api-version | True | string |
wersja API |
|
dane wejściowe
|
input | True | string |
Tekst wejściowy do pobrania osadzania dla elementu zakodowany jako ciąg. Ciąg wejściowy nie może przekraczać 2048 tokenów długości |
|
użytkownik
|
user | string |
Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc Azure openAI w celu monitorowania i wykrywania nadużyć. |
|
|
typ_wprowadzenia
|
input_type | string |
Typ danych wejściowych wyszukiwania osadzania do użycia. |
Zwraca
Pobieranie wielu osadzania
Uzyskiwanie reprezentacji wektorów dla danej tablicy danych wejściowych, które mogą być łatwo używane przez modele i algorytmy uczenia maszynowego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wdrożenia wdrożonego modelu
|
deployment-id | True | string |
Identyfikator wdrożenia wdrożonego modelu |
|
wersja API
|
api-version | True | string |
wersja API |
|
dane wejściowe
|
input | True | array of string |
Tablica tekstów wejściowych, dla których mają być osadzane, zakodowane jako ciąg. Każdy ciąg wejściowy nie może przekraczać 2048 tokenów długości |
|
użytkownik
|
user | string |
Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc Azure openAI w celu monitorowania i wykrywania nadużyć. |
|
|
typ_wprowadzenia
|
input_type | string |
Typ danych wejściowych wyszukiwania osadzania do użycia. |
Zwraca
Tworzenie uzupełniania wiadomości czatu przy użyciu rozszerzeń
Tworzenie uzupełniania wiadomości czatu przy użyciu rozszerzeń
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wdrożenia wdrożonego modelu
|
deployment-id | True | string |
Identyfikator wdrożenia wdrożonego modelu |
|
Potwierdzanie identyfikatora wdrożenia wdrożonego modelu
|
deploymentId | True | string |
Potwierdzanie identyfikatora wdrożenia wdrożonego modelu |
|
wersja API
|
api-version | True | string |
wersja API |
|
indeks
|
index | integer |
Indeks wiadomości w konwersacji. |
|
|
rola
|
role | True | string |
Rola autora tej wiadomości. |
|
adresat
|
recipient | string |
Adresat wiadomości w formacie <przestrzeni nazw>.<operacja>. Prezentuj, jeśli i tylko wtedy, gdy adresat jest narzędziem. |
|
|
zawartość
|
content | True | string |
Zawartość wiadomości |
|
end_turn
|
end_turn | boolean |
Czy komunikat kończy się kolei. |
|
|
typ
|
type | True | string |
Typ źródła danych. |
|
parameters
|
parameters | object |
Parametry, które mają być używane dla źródła danych w środowisku uruchomieniowym. |
|
|
temperatura
|
temperature | number |
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
|
top_p | number |
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 |
|
|
odtwarzać strumieniowo
|
stream | boolean |
W przypadku ustawienia zostaną wysłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny będą wysyłane jako zdarzenia jednokierunkowe przesyłane do serwera w miarę ich dostępności, a strumień zostanie zakończony komunikatem |
|
|
stop
|
stop | array of string |
Minimalny rozmiar tablicy 1 i maksymalnie 4 |
|
|
maks_tokenów
|
max_tokens | integer |
Maksymalna liczba tokenów dozwolonych dla wygenerowanej odpowiedzi. Domyślnie liczba tokenów, które model może zwrócić, wynosi (4096 - tokeny podpowiedzi). |
|
|
kara_obecności
|
presence_penalty | number |
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. |
|
|
kara za częstotliwość
|
frequency_penalty | number |
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. |
|
|
odchylenie logistyczne
|
logit_bias | object |
Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z -100 do 100. Matematycznie, przesunięcie jest dodawane do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnić w zależności od modelu, ale wartości z zakresu od -1 do 1 powinny zmniejszyć lub zwiększyć prawdopodobieństwo wyboru; wartości takie jak -100 lub 100 powinny spowodować zakaz lub wyłączny wybór odpowiedniego tokenu. |
|
|
użytkownik
|
user | string |
Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc Azure openAI w celu monitorowania i wykrywania nadużyć. |
Zwraca
Odpowiedź na zakończenia czatu rozszerzeń.
Tworzy uzupełnienie wiadomości na czacie
Tworzy uzupełnienie wiadomości na czacie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wdrożenia wdrożonego modelu
|
deployment-id | True | string |
Identyfikator wdrożenia wdrożonego modelu |
|
wersja API
|
api-version | True | string |
wersja API |
|
temperatura
|
temperature | number |
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
|
top_p | number |
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 |
|
|
odtwarzać strumieniowo
|
stream | boolean |
W przypadku ustawienia zostaną wysłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny będą wysyłane jako zdarzenia jednokierunkowe przesyłane do serwera w miarę ich dostępności, a strumień zostanie zakończony komunikatem |
|
|
stop
|
stop | array of string |
Maksymalnie 4 sekwencje, w których interfejs API przestanie generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania. |
|
|
maks_tokenów
|
max_tokens | integer |
Maksymalna liczba tokenów dozwolonych dla wygenerowanej odpowiedzi. Domyślnie liczba tokenów, które model może zwrócić, wynosi (4096 - tokeny podpowiedzi). |
|
|
kara_obecności
|
presence_penalty | number |
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. |
|
|
kara za częstotliwość
|
frequency_penalty | number |
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. |
|
|
odchylenie logistyczne
|
logit_bias | object |
Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z -100 do 100. Matematycznie, przesunięcie jest dodawane do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnić w zależności od modelu, ale wartości z zakresu od -1 do 1 powinny zmniejszyć lub zwiększyć prawdopodobieństwo wyboru; wartości takie jak -100 lub 100 powinny spowodować zakaz lub wyłączny wybór odpowiedniego tokenu. |
|
|
użytkownik
|
user | string |
Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc Azure openAI w celu monitorowania i wykrywania nadużyć. |
|
|
rola
|
role | True | string |
Rola autora wiadomości. |
|
zawartość
|
content | True | string |
Tablica części zawartości o zdefiniowanym typie może być typu |
|
typ
|
type | True | string |
Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu openAI Azure. Będzie to używane przez żądanie ukończenia czatu, które powinno używać Azure rozszerzenia czatu OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z Azure OpenAI. |
|
top_n_documents
|
top_n_documents | integer |
Skonfigurowana maksymalna liczba dokumentów do wyświetlenia dla skonfigurowanego zapytania. |
|
|
w zakresie
|
in_scope | boolean |
Czy zapytania powinny być ograniczone do używania indeksowanych danych. |
|
|
ścisłość
|
strictness | integer |
Skonfigurowana dokładność filtrowania istotności wyszukiwania. Im większa jest surowość, tym większa precyzja, ale niższa kompletność odpowiedzi. |
|
|
informacje_o_roli
|
role_information | string |
Przekaż instrukcje dotyczące sposobu działania modelu i dowolnego kontekstu, do którego powinien się odwoływać podczas generowania odpowiedzi. Możesz opisać osobowość asystenta i poinformować go, jak formatować odpowiedzi. Istnieje limit 100 tokenów, a są one liczone w stosunku do ogólnego limitu tokenów. |
|
|
nazwa_indeksu
|
index_name | True | string |
Nazwa indeksu, który ma być używany jako dostępny w przywoływowanym zasobie Azure Search. |
|
pole_tytułu
|
title_field | string |
Nazwa pola indeksu, które ma być używane jako tytuł. |
|
|
url_field
|
url_field | string |
Nazwa pola indeksu, które ma być używane jako adres URL. |
|
|
pole ścieżki pliku
|
filepath_field | string |
Nazwa pola indeksu do użycia jako ścieżka pliku. |
|
|
pola_treści
|
content_fields | array of string |
Nazwy pól indeksu, które powinny być traktowane jako zawartość. |
|
|
separator_pól_treści
|
content_fields_separator | string |
Wzorzec separatora, którego powinny używać pola zawartości. |
|
|
pola wektorowe
|
vector_fields | array of string |
Nazwy pól reprezentujących dane wektorowe. |
|
|
typ_zapytania
|
query_type | string |
Typ zapytania pobierania wyszukiwania Azure, które należy wykonać podczas korzystania z niego jako rozszerzenie czatu openAI Azure. |
|
|
konfiguracja semantyczna
|
semantic_configuration | string |
Dodatkowa konfiguracja semantyczna zapytania. |
|
|
filtr
|
filter | string |
Filtr wyszukiwania. |
|
|
typ
|
type | string |
Reprezentuje dostępne źródła Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym. |
|
|
nazwa wdrożenia
|
deployment_name | True | string |
Określa nazwę wdrożenia modelu do użycia na potrzeby wektoryzacji. To wdrożenie modelu musi znajdować się w tym samym Azure zasobie OpenAI, ale w danych będzie używać tego wdrożenia modelu za pośrednictwem wywołania wewnętrznego, a nie publicznego, co umożliwia wyszukiwanie wektorów nawet w sieciach prywatnych. |
|
n
|
n | integer |
Ile opcji ukończenia czatu ma być generowanych dla każdej wiadomości wejściowej. |
|
|
seed
|
seed | integer |
Jeśli zostanie określony, nasz system podejmie najlepsze wysiłki, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi |
|
|
logprobs
|
logprobs | boolean |
Czy zwracać logarytmiczne prawdopodobieństwa dla tokenów wyjściowych, czy nie. Jeśli true, zwraca logarytmiczne prawdopodobieństwa każdego tokenu wyjściowego zwróconego w |
|
|
top_logprobs
|
top_logprobs | integer |
Liczba całkowita z zakresu od 0 do 5 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji tokenu, z których każde ma skojarzone prawdopodobieństwo dziennika.
|
|
|
typ
|
type | string |
Ustawienie w celu |
Zwraca
Definicje
Message
Wiadomość czatu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
indeks
|
index | integer |
Indeks wiadomości w konwersacji. |
|
rola
|
role | string |
Rola autora tej wiadomości. |
|
adresat
|
recipient | string |
Adresat wiadomości w formacie <przestrzeni nazw>.<operacja>. Prezentuj, jeśli i tylko wtedy, gdy adresat jest narzędziem. |
|
zawartość
|
content | string |
Zawartość wiadomości |
|
end_turn
|
end_turn | boolean |
Czy komunikat kończy się kolei. |
ExtensionsChatCompletionsResponse
Odpowiedź na zakończenia czatu rozszerzeń.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
obiekt
|
object | string | |
|
utworzone
|
created | integer | |
|
model
|
model | string | |
|
prompt_filter_results
|
prompt_filter_results | promptFilterResults |
Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych poleceń mogą pojawiać się o różnych porach lub w różnej kolejności. |
|
prompt_tokens
|
usage.prompt_tokens | integer | |
|
completion_tokens
|
usage.completion_tokens | integer | |
|
total_tokens
|
usage.total_tokens | integer | |
|
choices
|
choices | array of ExtensionsChatCompletionChoice |
ExtensionsChatCompletionChoice
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
indeks
|
index | integer | |
|
powód zakończenia
|
finish_reason | string | |
|
content_filter_results
|
content_filter_results | contentFilterResults |
Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie. |
|
messages
|
messages | array of Message |
Lista komunikatów zwracanych przez usługę. |
contentFilterResult
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
severity
|
severity | string | |
|
filtered
|
filtered | boolean |
contentFilterResults
Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
sexual
|
sexual | contentFilterResult | |
|
violence
|
violence | contentFilterResult | |
|
hate
|
hate | contentFilterResult | |
|
self_harm
|
self_harm | contentFilterResult | |
|
błąd
|
error | errorBase |
WynikFiltrowaniaPromptu
Wyniki filtrowania treści dla pojedynczego polecenia w żądaniu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
prompt_index
|
prompt_index | integer | |
|
content_filter_results
|
content_filter_results | contentFilterResults |
Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie. |
pokażWynikiFiltru
Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych poleceń mogą pojawiać się o różnych porach lub w różnej kolejności.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
promptFilterResult |
Wyniki filtrowania treści dla pojedynczego polecenia w żądaniu. |
errorBase
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string | |
|
komunikat
|
message | string |
errorBase_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string | |
|
komunikat
|
message | string |
contentFilterSeverityResult_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
severity
|
severity | string |
contentFilterDetectedResult_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
detected
|
detected | boolean |
contentFilterDetectedWithCitationResult_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
detected
|
detected | boolean | |
|
adres URL
|
citation.URL | string | |
|
licencja
|
citation.license | string |
contentFilterIdResult_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
filtered
|
filtered | boolean |
contentFilterPromptResults_2024Feb15Preview
Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
sexual
|
sexual | contentFilterSeverityResult_2024Feb15Preview | |
|
violence
|
violence | contentFilterSeverityResult_2024Feb15Preview | |
|
hate
|
hate | contentFilterSeverityResult_2024Feb15Preview | |
|
self_harm
|
self_harm | contentFilterSeverityResult_2024Feb15Preview | |
|
profanity
|
profanity | contentFilterDetectedResult_2024Feb15Preview | |
|
custom_blocklists
|
custom_blocklists | array of contentFilterIdResult_2024Feb15Preview | |
|
błąd
|
error | errorBase_2024Feb15Preview | |
|
jailbreak
|
jailbreak | contentFilterDetectedResult_2024Feb15Preview |
contentFilterChoiceResults_2024Feb15Preview
Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie. Informacje o tekście pochodzącym od podmiotów trzecich oraz o wulgaryzmach, czy zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
sexual
|
sexual | contentFilterSeverityResult_2024Feb15Preview | |
|
violence
|
violence | contentFilterSeverityResult_2024Feb15Preview | |
|
hate
|
hate | contentFilterSeverityResult_2024Feb15Preview | |
|
self_harm
|
self_harm | contentFilterSeverityResult_2024Feb15Preview | |
|
profanity
|
profanity | contentFilterDetectedResult_2024Feb15Preview | |
|
custom_blocklists
|
custom_blocklists | array of contentFilterIdResult_2024Feb15Preview | |
|
błąd
|
error | errorBase_2024Feb15Preview | |
|
protected_material_text
|
protected_material_text | contentFilterDetectedResult_2024Feb15Preview | |
|
protected_material_code
|
protected_material_code | contentFilterDetectedWithCitationResult_2024Feb15Preview |
promptFilterResult_2024Feb15Preview
Wyniki filtrowania treści dla pojedynczego polecenia w żądaniu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
prompt_index
|
prompt_index | integer | |
|
content_filter_results
|
content_filter_results | contentFilterPromptResults_2024Feb15Preview |
Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator. |
promptFilterResults_2024Feb15Preview
Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych poleceń mogą pojawiać się o różnych porach lub w różnej kolejności.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
promptFilterResult_2024Feb15Preview |
Wyniki filtrowania treści dla pojedynczego polecenia w żądaniu. |
azureChatExtensionsMessageContext_2024Feb15Preview
Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy Azure rozszerzenia czatu OpenAI są zaangażowane w generowanie odpowiedniej odpowiedzi zakończenia czatu. Te informacje kontekstowe są wypełniane tylko w przypadku korzystania z Azure żądania OpenAI skonfigurowanego do używania pasującego rozszerzenia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
citations
|
citations | array of citation_2024Feb15Preview |
Wynik pobierania źródła danych używany do generowania komunikatu asystenta w odpowiedzi. |
|
intencja
|
intent | string |
Wykryta intencja z historii czatu, używana przy przejściu do następnego kroku, by przenieść kontekst. |
citation_2024Feb15Preview
informacje o cytatach dla komunikatu odpowiedzi zakończenia czatu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | string |
Zawartość cytatu. |
|
title
|
title | string |
Tytuł cytatu. |
|
URL
|
url | string |
Adres URL cytatu. |
|
ścieżka pliku
|
filepath | string |
Ścieżka pliku cytatu. |
|
identyfikator_kawałka
|
chunk_id | string |
Identyfikator fragmentu cytatu. |
createChatCompletionResponse_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator ukończenia czatu. |
|
obiekt
|
object | chatCompletionResponseObject_2024Feb15Preview |
Typ obiektu. |
|
utworzone
|
created | integer |
Sygnatura czasowa systemu Unix (w sekundach) wskazująca moment utworzenia zakończenia czatu. |
|
model
|
model | string |
Model używany do ukończenia czatu. |
|
użycie
|
usage | completionUsage_2024Feb15Preview |
Statystyki użycia dotyczące żądania zakończenia. |
|
system_fingerprint
|
system_fingerprint | string |
Można użyć w połączeniu z parametrem żądania |
|
prompt_filter_results
|
prompt_filter_results | promptFilterResults_2024Feb15Preview |
Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych poleceń mogą pojawiać się o różnych porach lub w różnej kolejności. |
|
choices
|
choices | array of object | |
|
indeks
|
choices.index | integer | |
|
powód zakończenia
|
choices.finish_reason | string | |
|
komunikat
|
choices.message | chatCompletionResponseMessage_2024Feb15Preview |
Komunikat ukończenia czatu wygenerowany przez model. |
|
content_filter_results
|
choices.content_filter_results | contentFilterChoiceResults_2024Feb15Preview |
Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie. Informacje o tekście pochodzącym od podmiotów trzecich oraz o wulgaryzmach, czy zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator. |
|
logprobs
|
choices.logprobs | chatCompletionChoiceLogProbs_2024Feb15Preview |
Informacje o logarytmicznym prawdopodobieństwie dla wybranej opcji. |
chatCompletionChoiceLogProbs_2024Feb15Preview
Informacje o logarytmicznym prawdopodobieństwie dla wybranej opcji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | array of chatCompletionTokenLogprob_2024Feb15Preview |
Lista tokenów zawartości komunikatów z informacjami o prawdopodobieństwie logarytmicznym. |
chatCompletionTokenLogprob_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod przedpłaty
|
token | string |
Znacznik. |
|
logprob
|
logprob | number |
Logarytm prawdopodobieństwa tego tokenu. |
|
bytes
|
bytes | array of integer |
Lista liczb całkowitych reprezentujących reprezentację tokenu w bajtach UTF-8. Przydatne w wystąpieniach, w których znaki są reprezentowane przez wiele tokenów, a ich reprezentacje bajtów muszą być łączone, aby wygenerować poprawną reprezentację tekstu. Może to być |
|
top_logprobs
|
top_logprobs | array of object |
Lista najbardziej prawdopodobnych tokenów i ich logarytmicznych prawdopodobieństw na tej pozycji tokenu. W rzadkich przypadkach może zostać zwróconych mniej elementów |
|
kod przedpłaty
|
top_logprobs.token | string |
Znacznik. |
|
logprob
|
top_logprobs.logprob | number |
Logarytm prawdopodobieństwa tego tokenu. |
|
bytes
|
top_logprobs.bytes | array of integer |
Lista liczb całkowitych reprezentujących reprezentację tokenu w bajtach UTF-8. Przydatne w wystąpieniach, w których znaki są reprezentowane przez wiele tokenów, a ich reprezentacje bajtów muszą być łączone, aby wygenerować poprawną reprezentację tekstu. Może to być |
chatCompletionResponseMessage_2024Feb15Preview
Komunikat ukończenia czatu wygenerowany przez model.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
rola
|
role | chatCompletionResponseMessageRole_2024Feb15Preview |
Rola autora komunikatu odpowiedzi. |
|
zawartość
|
content | string |
Zawartość wiadomości. |
|
kontekst
|
context | azureChatExtensionsMessageContext_2024Feb15Preview |
Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy Azure rozszerzenia czatu OpenAI są zaangażowane w generowanie odpowiedniej odpowiedzi zakończenia czatu. Te informacje kontekstowe są wypełniane tylko w przypadku korzystania z Azure żądania OpenAI skonfigurowanego do używania pasującego rozszerzenia. |
chatCompletionResponseMessageRole_2024Feb15Preview
chatCompletionResponseObject_2024Feb15Preview
completionUsage_2024Feb15Preview
Statystyki użycia dotyczące żądania zakończenia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
prompt_tokens
|
prompt_tokens | integer |
Liczba tokenów w prompt. |
|
completion_tokens
|
completion_tokens | integer |
Liczba tokenów w wygenerowanym zakończeniu. |
|
total_tokens
|
total_tokens | integer |
Łączna liczba tokenów użytych w żądaniu (zapytanie + ukończenie). |
getSingleEmbeddingsResponse_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
obiekt
|
object | string |
Szczegóły typu obiektu odpowiedzi |
|
model
|
model | string |
Nazwa modelu |
|
embedding
|
embedding | array of number |
Tablica zmiennoprzecinkowych reprezentujących obliczone osadzanie dla danych wejściowych |
|
prompt_tokens
|
usage.prompt_tokens | integer |
Liczba tokenów używanych w danych wejściowych |
|
total_tokens
|
usage.total_tokens | integer |
Łączna liczba użytych tokenów |
getMultipleEmbeddingsResponse_2024Feb15Preview
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
obiekt
|
object | string |
Szczegóły typu obiektu odpowiedzi |
|
model
|
model | string |
Nazwa modelu |
|
embeddings
|
embeddings | array of array |
Tablica z tablicami zmiennoprzecinkowych reprezentującymi obliczone osadzanie kolekcji ciągów wejściowych |
|
items
|
embeddings | array of number | |
|
prompt_tokens
|
usage.prompt_tokens | integer |
Liczba tokenów używanych w danych wejściowych |
|
total_tokens
|
usage.total_tokens | integer |
Łączna liczba użytych tokenów |