Szybki start: korzystanie z wykrywania naziemności (wersja zapoznawcza)

Artykuł
10/29/2024

W tym przewodniku pokazano, jak używać interfejsu API wykrywania uziemienia. Ta funkcja automatycznie wykrywa i poprawia nieprzyziemny tekst na podstawie dostarczonych dokumentów źródłowych, zapewniając, że wygenerowana zawartość jest zgodna z faktycznymi lub zamierzonymi odwołaniami. Poniżej przedstawiono kilka typowych scenariuszy, które pomogą Ci zrozumieć, jak i kiedy zastosować te funkcje w celu uzyskania najlepszych wyników.

Wymagania wstępne

Subskrypcja platformy Azure — utwórz bezpłatnie
Po utworzeniu subskrypcji platformy Azure utwórz zasób Bezpieczeństwo zawartości w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Wprowadź unikatową nazwę zasobu, wybierz subskrypcję i wybierz grupę zasobów, obsługiwany region i obsługiwaną warstwę cenową. Następnie wybierz Utwórz.
Wdrożenie zasobu trwa kilka minut. Po jego zakończeniu przejdź do nowego zasobu. W okienku po lewej stronie w obszarze Zarządzanie zasobami wybierz pozycję Klucze interfejsu API i punkty końcowe. Skopiuj jedną z wartości klucza subskrypcji i punktu końcowego do lokalizacji tymczasowej do późniejszego użycia.
(Opcjonalnie) Jeśli chcesz użyć funkcji rozumowania , utwórz zasób usługi Azure OpenAI z wdrożonym modelem GPT.
Zainstalowano bibliotekę cURL lub python .

Sprawdzanie uziemienia bez rozumowania

W prostym przypadku bez funkcji rozumowania interfejs API wykrywania naziemności klasyfikuje nieprzyziemność przesłanej zawartości jako true lub false.

cURL
Python

W tej sekcji przedstawiono przykładowe żądanie z biblioteką cURL. Wklej poniższe polecenie do edytora tekstów i wprowadź następujące zmiany.

Zastąp ciąg <endpoint> adresem URL punktu końcowego skojarzonym z zasobem.
Zastąp <your_subscription_key> element jednym z kluczy zasobu.

Opcjonalnie zastąp "query" pola lub "text" w treści własnym tekstem, który chcesz przeanalizować.

curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domain": "Generic",
  "task": "QnA",
  "qna": {
    "query": "How much does she currently get paid per hour at the bank?"
  },
  "text": "12/hour",
  "groundingSources": [
    "I'm 21 years old and I need to make a decision about the next two years of my life. Within a week. I currently work for a bank that requires strict sales goals to meet. IF they aren't met three times (three months) you're canned. They pay me 10/hour and it's not unheard of to get a raise in 6ish months. The issue is, **I'm not a salesperson**. That's not my personality. I'm amazing at customer service, I have the most positive customer service \"reports\" done about me in the short time I've worked here. A coworker asked \"do you ask for people to fill these out? you have a ton\". That being said, I have a job opportunity at Chase Bank as a part time teller. What makes this decision so hard is that at my current job, I get 40 hours and Chase could only offer me 20 hours/week. Drive time to my current job is also 21 miles **one way** while Chase is literally 1.8 miles from my house, allowing me to go home for lunch. I do have an apartment and an awesome roommate that I know wont be late on his portion of rent, so paying bills with 20hours a week isn't the issue. It's the spending money and being broke all the time.\n\nI previously worked at Wal-Mart and took home just about 400 dollars every other week. So I know i can survive on this income. I just don't know whether I should go for Chase as I could definitely see myself having a career there. I'm a math major likely going to become an actuary, so Chase could provide excellent opportunities for me **eventually**."
  ],
  "reasoning": false
}'

Otwórz wiersz polecenia i uruchom polecenie cURL.

Utwórz nowy plik w języku Python o nazwie quickstart.py. Otwórz nowy plik w preferowanym edytorze lub środowisku IDE.

Zastąp zawartość quickstart.py poniższym kodem. Wprowadź adres URL i klucz punktu końcowego w odpowiednich polach. Opcjonalnie zastąp "query" pola lub "text" w treści własnym tekstem, który chcesz przeanalizować.

import http.client
import json

endpoint = "<your_custom_subdomain>.cognitiveservices.azure.com"
conn = http.client.HTTPSConnection(endpoint)
payload = json.dumps({
  "domain": "Generic",
  "task": "QnA",
  "qna": {
    "query": "How much does she currently get paid per hour at the bank?"
  },
  "text": "12/hour",
  "groundingSources": [
    "I'm 21 years old and I need to make a decision about the next two years of my life. Within a week. I currently work for a bank that requires strict sales goals to meet. IF they aren't met three times (three months) you're canned. They pay me 10/hour and it's not unheard of to get a raise in 6ish months. The issue is, **I'm not a salesperson**. That's not my personality. I'm amazing at customer service, I have the most positive customer service \"reports\" done about me in the short time I've worked here. A coworker asked \"do you ask for people to fill these out? you have a ton\". That being said, I have a job opportunity at Chase Bank as a part time teller. What makes this decision so hard is that at my current job, I get 40 hours and Chase could only offer me 20 hours/week. Drive time to my current job is also 21 miles **one way** while Chase is literally 1.8 miles from my house, allowing me to go home for lunch. I do have an apartment and an awesome roommate that I know wont be late on his portion of rent, so paying bills with 20hours a week isn't the issue. It's the spending money and being broke all the time.\n\nI previously worked at Wal-Mart and took home just about 400 dollars every other week. So I know i can survive on this income. I just don't know whether I should go for Chase as I could definitely see myself having a career there. I'm a math major likely going to become an actuary, so Chase could provide excellent opportunities for me **eventually**."
  ],
  "reasoning": false
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your_subscription_key>',
  'Content-Type': 'application/json'
}
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Ważne

Pamiętaj, aby usunąć klucz z kodu po zakończeniu i nigdy nie publikować klucza publicznie. W środowisku produkcyjnym należy użyć bezpiecznego sposobu przechowywania poświadczeń i uzyskiwania do nich dostępu. Aby uzyskać więcej informacji, zobacz Azure Key Vault.

Uruchom aplikację za python pomocą polecenia :
```
python quickstart.py
```
Poczekaj chwilę, aby uzyskać odpowiedź.

Aby przetestować zadanie podsumowania zamiast zadania odpowiedzi na pytania (QnA), użyj następującej przykładowej treści JSON:

{
  "domain": "Medical",
  "task": "Summarization",
  "text": "Ms Johnson has been in the hospital after experiencing a stroke.",
  "groundingSources": [
    "Our patient, Ms. Johnson, presented with persistent fatigue, unexplained weight loss, and frequent night sweats. After a series of tests, she was diagnosed with Hodgkin’s lymphoma, a type of cancer that affects the lymphatic system. The diagnosis was confirmed through a lymph node biopsy revealing the presence of Reed-Sternberg cells, a characteristic of this disease. She was further staged using PET-CT scans. Her treatment plan includes chemotherapy and possibly radiation therapy, depending on her response to treatment. The medical team remains optimistic about her prognosis given the high cure rate of Hodgkin’s lymphoma."
  ],
  "reasoning": false
}

Adres URL musi zawierać następujące pola:

Nazwisko	Wymagania	opis	Type
Wersja interfejsu API	Wymagania	Jest to wersja interfejsu API, która ma być używana. Bieżąca wersja to: api-version=2024-09-15-preview. Przykład: `<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview`	String

Parametry w treści żądania są zdefiniowane w tej tabeli:

Nazwa/nazwisko	opis	Type
domena	(Opcjonalnie) `MEDICAL` lub `GENERIC`. Wartość domyślna: `GENERIC`.	Wyliczenie
zadanie	(Opcjonalnie) Typ zadania: `QnA`, `Summarization`. Wartość domyślna: `Summarization`.	Wyliczenie
qna	(Opcjonalnie) Przechowuje dane usługi QnA, gdy typ zadania to `QnA`.	String
- `query`	(Opcjonalnie) Reprezentuje to pytanie w zadaniu pytań i odpowiedzi. Limit znaków: 7500.	String
text	(Wymagane) Tekst wyjściowy llM, który ma zostać sprawdzony. Limit znaków: 7500.	String
groundingSources	(Wymagane) Używa tablicy źródeł uziemienia do weryfikowania tekstu generowanego przez sztuczną inteligencję. Zobacz Wymagania dotyczące danych wejściowych, aby uzyskać informacje o limitach.	Tablica ciągów
Rozumowanie	(Opcjonalnie) Określa, czy należy używać funkcji rozumowania. Domyślna wartość to `false`. Jeśli `true`element to , musisz wprowadzić własny interfejs GPT4o usługi Azure OpenAI (0513, 0806), aby podać wyjaśnienie. Należy zachować ostrożność: użycie rozumowania zwiększa czas przetwarzania.	Wartość logiczna

Interpretowanie odpowiedzi interfejsu API

Po przesłaniu żądania otrzymasz odpowiedź JSON odzwierciedlając wykonaną analizę groundedness. Oto jak wyglądają typowe dane wyjściowe:

{
  "ungroundedDetected": true,
  "ungroundedPercentage": 1,
  "ungroundedDetails": [
    {
      "text": "12/hour."
    }
  ]
}

Obiekty JSON w danych wyjściowych są zdefiniowane tutaj:

Nazwa/nazwisko	opis	Type
ungroundedDetected	Wskazuje, czy tekst wykazuje nieprzyziemność.	Wartość logiczna
ungroundedPercentage	Określa proporcję tekstu zidentyfikowanego jako nieziemierny, wyrażony jako liczba z zakresu od 0 do 1, gdzie wartość 0 nie wskazuje zawartości nieprzystawionej, a 1 oznacza całkowicie nieprzyziemną zawartość.	Liczba zmiennoprzecinkowa
ungroundedDetails	Udostępnia szczegółowe informacje na temat zawartości bez planu z określonymi przykładami i wartościami procentowymi.	Tablica
-`text`	Określony tekst, który jest nieprzystawiony.	String

Sprawdzanie uziemienia z rozumowaniem

Interfejs API wykrywania naziemności udostępnia opcję uwzględniania rozumowania w odpowiedzi interfejsu API. Po włączeniu rozumowania odpowiedź zawiera "reasoning" pole, które zawiera szczegółowe informacje o określonych wystąpieniach i wyjaśnieniach dotyczących wszelkich wykrytych nieprzystawień.

Łączenie własnego wdrożenia GPT

Napiwek

Obsługujemy tylko zasoby **Azure OpenAI GPT4o (0513, 0806) ** i nie obsługują innych typów GPT. Masz elastyczność wdrażania zasobów usługi Azure OpenAI GPT4o (0513, 0806) w dowolnym regionie. Jednak aby zminimalizować potencjalne opóźnienia i uniknąć wszelkich problemów związanych z prywatnością danych i ryzykiem granic geograficznych, zalecamy usiąść je w tym samym regionie co zasoby bezpieczeństwa zawartości. Aby uzyskać szczegółowe informacje na temat prywatności danych, zapoznaj się z wytycznymi dotyczącymi danych, prywatności i zabezpieczeń dla usługi Azure OpenAI Service i danych, prywatności i zabezpieczeń bezpieczeństwa zawartości usługi Azure AI.

Aby użyć zasobu usługi Azure OpenAI GPT4o (0513, 0806 w wersji), aby włączyć funkcję rozumowania, użyj tożsamości zarządzanej, aby zezwolić zasobowi Bezpieczeństwo zawartości na dostęp do zasobu usługi Azure OpenAI:

Włącz tożsamość zarządzaną dla bezpieczeństwa zawartości usługi Azure AI.

Przejdź do wystąpienia bezpieczeństwa zawartości usługi Azure AI w witrynie Azure Portal. Znajdź sekcję Tożsamość w kategorii Ustawienia . Włącz tożsamość zarządzaną przypisaną przez system. Ta akcja umożliwia wystąpieniu bezpieczeństwa zawartości usługi Azure AI tożsamość, która może być rozpoznawana i używana na platformie Azure do uzyskiwania dostępu do innych zasobów.
Przypisz rolę do tożsamości zarządzanej.

Przejdź do wystąpienia usługi Azure OpenAI, wybierz pozycję Dodaj przypisanie roli, aby rozpocząć proces przypisywania roli usługi Azure OpenAI do tożsamości bezpieczeństwa zawartości usługi Azure AI.

Wybierz rolę Użytkownik lub Współautor.

Wysyłanie żądania interfejsu API

W żądaniu do interfejsu API wykrywania naziemności ustaw "reasoning" parametr treści na true, a następnie podaj inne wymagane parametry:


{
  "domain": "Medical",
  "task": "Summarization",
  "text": "The patient name is Kevin.",
  "groundingSources": [
    "The patient name is Jane."
  ],
  "reasoning": true,
  "llmResource": {
    "resourceType": "AzureOpenAI",
    "azureOpenAIEndpoint": "<your_OpenAI_endpoint>",
    "azureOpenAIDeploymentName": "<your_deployment_name>"
  }
}

cURL
Python

W tej sekcji przedstawiono przykładowe żądanie z biblioteką cURL. Wklej poniższe polecenie do edytora tekstów i wprowadź następujące zmiany.

Zastąp <endpoint> ciąg adresem URL punktu końcowego skojarzonym z zasobem Bezpieczeństwo zawartości usługi Azure AI.
Zastąp <your_subscription_key> element jednym z kluczy zasobu.
Zastąp <your_OpenAI_endpoint> ciąg adresem URL punktu końcowego skojarzonym z zasobem usługi Azure OpenAI.
Zastąp <your_deployment_name> ciąg nazwą wdrożenia usługi Azure OpenAI.

Opcjonalnie zastąp "query" pola lub "text" w treści własnym tekstem, który chcesz przeanalizować.

curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domain": "Generic",
  "task": "QnA",
  "qna": {
    "query": "How much does she currently get paid per hour at the bank?"
  },
  "text": "12/hour",
  "groundingSources": [
    "I'm 21 years old and I need to make a decision about the next two years of my life. Within a week. I currently work for a bank that requires strict sales goals to meet. If they aren't met three times (three months) you're canned. They pay me 10/hour and it's not unheard of to get a raise in 6ish months. The issue is, **I'm not a salesperson**. That's not my personality. I'm amazing at customer service, I have the most positive customer service \"reports\" done about me in the short time I've worked here. A coworker asked \"do you ask for people to fill these out? you have a ton\". That being said, I have a job opportunity at Chase Bank as a part time teller. What makes this decision so hard is that at my current job, I get 40 hours and Chase could only offer me 20 hours/week. Drive time to my current job is also 21 miles **one way** while Chase is literally 1.8 miles from my house, allowing me to go home for lunch. I do have an apartment and an awesome roommate that I know wont be late on his portion of rent, so paying bills with 20hours a week isn't the issue. It's the spending money and being broke all the time.\n\nI previously worked at Wal-Mart and took home just about 400 dollars every other week. So I know i can survive on this income. I just don't know whether I should go for Chase as I could definitely see myself having a career there. I'm a math major likely going to become an actuary, so Chase could provide excellent opportunities for me **eventually**."
  ],
  "reasoning": true,
  "llmResource": {
        "resourceType": "AzureOpenAI",
        "azureOpenAIEndpoint": "<your_OpenAI_endpoint>",
        "azureOpenAIDeploymentName": "<your_deployment_name>"
}'

Otwórz wiersz polecenia i uruchom polecenie cURL.

Utwórz nowy plik w języku Python o nazwie quickstart.py. Otwórz nowy plik w preferowanym edytorze lub środowisku IDE.

Zastąp zawartość quickstart.py poniższym kodem. Wprowadź adres URL i klucz punktu końcowego w odpowiednich polach. Wprowadź również nazwę punktu końcowego i wdrożenia usługi Azure OpenAI. Opcjonalnie zastąp "query" pola lub "text" w treści własnym tekstem, który chcesz przeanalizować.

import http.client
import json

conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview")
payload = json.dumps({
  "domain": "Generic",
  "task": "QnA",
  "qna": {
    "query": "How much does she currently get paid per hour at the bank?"
  },
  "text": "12/hour",
  "groundingSources": [
    "I'm 21 years old and I need to make a decision about the next two years of my life. Within a week. I currently work for a bank that requires strict sales goals to meet. IF they aren't met three times (three months) you're canned. They pay me 10/hour and it's not unheard of to get a raise in 6ish months. The issue is, **I'm not a salesperson**. That's not my personality. I'm amazing at customer service, I have the most positive customer service \"reports\" done about me in the short time I've worked here. A coworker asked \"do you ask for people to fill these out? you have a ton\". That being said, I have a job opportunity at Chase Bank as a part time teller. What makes this decision so hard is that at my current job, I get 40 hours and Chase could only offer me 20 hours/week. Drive time to my current job is also 21 miles **one way** while Chase is literally 1.8 miles from my house, allowing me to go home for lunch. I do have an apartment and an awesome roommate that I know wont be late on his portion of rent, so paying bills with 20hours a week isn't the issue. It's the spending money and being broke all the time.\n\nI previously worked at Wal-Mart and took home just about 400 dollars every other week. So I know i can survive on this income. I just don't know whether I should go for Chase as I could definitely see myself having a career there. I'm a math major likely going to become an actuary, so Chase could provide excellent opportunities for me **eventually**."
  ],
  "reasoning": True
  "llmResource": {
   "resourceType": "AzureOpenAI",
   "azureOpenAIEndpoint": "<your_OpenAI_endpoint>",
   "azureOpenAIDeploymentName": "<your_deployment_name>"
  }
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your_subscription_key>',
  'Content-Type': 'application/json'
}
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Uruchom aplikację za python pomocą polecenia :
```
python quickstart.py
```
Poczekaj chwilę, aby uzyskać odpowiedź.

Parametry w treści żądania są zdefiniowane w tej tabeli:

Nazwa/nazwisko	opis	Type
domena	(Opcjonalnie) `MEDICAL` lub `GENERIC`. Wartość domyślna: `GENERIC`.	Wyliczenie
zadanie	(Opcjonalnie) Typ zadania: `QnA`, `Summarization`. Wartość domyślna: `Summarization`.	Wyliczenie
qna	(Opcjonalnie) Przechowuje dane usługi QnA, gdy typ zadania to `QnA`.	String
- `query`	(Opcjonalnie) Reprezentuje to pytanie w zadaniu pytań i odpowiedzi. Limit znaków: 7500.	String
text	(Wymagane) Tekst wyjściowy llM, który ma zostać sprawdzony. Limit znaków: 7500.	String
groundingSources	(Wymagane) Używa tablicy źródeł uziemienia do weryfikowania tekstu generowanego przez sztuczną inteligencję. Zobacz Wymagania dotyczące danych wejściowych dotyczące limitów,	Tablica ciągów
Rozumowanie	(Opcjonalnie) Ustaw wartość na `true`, usługa używa zasobów usługi Azure OpenAI w celu udostępnienia wyjaśnienia. Należy zachować ostrożność: użycie rozumowania zwiększa czas przetwarzania i wiąże się z dodatkowymi opłatami.	Wartość logiczna
llmResource	(Wymagane) Jeśli chcesz użyć własnego zasobu usługi Azure OpenAI GPT4o (0513, 0806 w wersji), aby włączyć rozumowanie, dodaj to pole i dołącz pola podrzędne dla używanych zasobów.	String
- `resourceType`	Określa typ używanego zasobu. Obecnie zezwala tylko na `AzureOpenAI`. Obsługujemy tylko zasoby usługi Azure OpenAI GPT4o (0513, 0806) i nie obsługują innych typów GPT.	Wyliczenie
- `azureOpenAIEndpoint`	Adres URL punktu końcowego dla usługi Azure OpenAI.	String
- `azureOpenAIDeploymentName`	Nazwa określonego wdrożenia GPT do użycia.	String

Interpretowanie odpowiedzi interfejsu API

Po przesłaniu żądania otrzymasz odpowiedź JSON odzwierciedlając wykonaną analizę groundedness. Oto jak wyglądają typowe dane wyjściowe:

{
  "ungroundedDetected": true,
  "ungroundedPercentage": 1,
  "ungroundedDetails": [
    {
      "text": "12/hour.",
      "offset": {
        "utf8": 0,
        "utf16": 0,
        "codePoint": 0
      },
      "length": {
        "utf8": 8,
        "utf16": 8,
        "codePoint": 8
      },
      "reason": "None. The premise mentions a pay of \"10/hour\" but does not mention \"12/hour.\" It's neutral. "
    }
  ]
}

Obiekty JSON w danych wyjściowych są zdefiniowane tutaj:

Nazwa/nazwisko	opis	Type
ungroundedDetected	Wskazuje, czy tekst wykazuje nieprzyziemność.	Wartość logiczna
ungroundedPercentage	Określa proporcję tekstu zidentyfikowanego jako nieziemierny, wyrażony jako liczba z zakresu od 0 do 1, gdzie wartość 0 nie wskazuje zawartości nieprzystawionej, a 1 oznacza całkowicie nieprzyziemną zawartość.	Liczba zmiennoprzecinkowa
ungroundedDetails	Udostępnia szczegółowe informacje na temat zawartości bez planu z określonymi przykładami i wartościami procentowymi.	Tablica
-`text`	Określony tekst, który jest nieprzystawiony.	String
-`offset`	Obiekt opisujący położenie tekstu bez pola w różnych kodowaniu.	String
- `offset > utf8`	Położenie przesunięcia tekstu bez pola w kodowaniu UTF-8.	Integer
- `offset > utf16`	Położenie przesunięcia tekstu bez pola w kodowaniu UTF-16.	Integer
- `offset > codePoint`	Położenie przesunięcia tekstu bez pola pod względem punktów kodu Unicode.	Integer
-`length`	Obiekt opisujący długość tekstu bez pola w różnych kodowaniu. (utf8, utf16, codePoint), podobnie jak przesunięcie.	Objekt
- `length > utf8`	Długość tekstu bez pola w kodowaniu UTF-8.	Integer
- `length > utf16`	Długość tekstu bez pola w kodowaniu UTF-16.	Integer
- `length > codePoint`	Długość tekstu bez pola pod względem punktów kodu Unicode.	Integer
-`reason`	Oferuje wyjaśnienia dotyczące wykrytej nieziemności.	String

Sprawdzanie uziemienia za pomocą funkcji korekty

Interfejs API wykrywania naziemności zawiera funkcję poprawek, która automatycznie poprawia wszelkie wykryte niezaziemnianie w tekście na podstawie podanych źródeł uziemienia. Po włączeniu funkcji korekty odpowiedź zawiera "correction Text" pole przedstawiające poprawiony tekst wyrównany do źródeł uziemienia.

Łączenie własnego wdrożenia GPT

Napiwek

Obecnie funkcja korekty obsługuje tylko zasoby **Azure OpenAI GPT4o (0513, 0806) ** zasobów. Aby zminimalizować opóźnienia i przestrzegać wytycznych dotyczących prywatności danych, zaleca się wdrożenie usługi Azure OpenAI GPT4o (wersja 0513, 0806) w tym samym regionie co zasoby bezpieczeństwa zawartości. Aby uzyskać więcej informacji na temat prywatności danych, zapoznaj się z wytycznymi dotyczącymi danych, prywatności i zabezpieczeń dla usługi Azure OpenAI Service i danych, prywatności i zabezpieczeń bezpieczeństwa zawartości usługi Azure AI.

Aby użyć zasobu usługi Azure OpenAI GPT4o (0513, 0806 w wersji) do włączenia funkcji korekty, użyj tożsamości zarządzanej, aby zezwolić zasobowi Bezpieczeństwo zawartości na dostęp do zasobu usługi Azure OpenAI. Wykonaj kroki opisane we wcześniejszej sekcji , aby skonfigurować tożsamość zarządzaną.

Wysyłanie żądania interfejsu API

W żądaniu do interfejsu API wykrywania uziemienia ustaw "correction" parametr treści na true, a następnie podaj inne niezbędne parametry:

{
  "domain": "Medical",
  "task": "Summarization",
  "text": "The patient name is Kevin.",
  "groundingSources": [
    "The patient name is Jane."
  ],
  "correction": true,
  "llmResource": {
    "resourceType": "AzureOpenAI",
    "azureOpenAIEndpoint": "<your_OpenAI_endpoint>",
    "azureOpenAIDeploymentName": "<your_deployment_name>"
  }
}

cURL
Python

W tej sekcji przedstawiono przykładowe żądanie przy użyciu biblioteki cURL. Zastąp symbole zastępcze zgodnie z potrzebami:

Zastąp ciąg <endpoint> adresem URL punktu końcowego zasobu.
Zastąp element <your_subscription_key> kluczem subskrypcji.
Opcjonalnie zastąp pole "tekst" tekstem, który chcesz przeanalizować.

curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview' \
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domain": "Generic",
  "task": "Summarization",
  "text": "The patient name is Kevin.",
  "groundingSources": [
    "The patient name is Jane."
  ],
  "correction": true,
  "llmResource": {
        "resourceType": "AzureOpenAI",
        "azureOpenAIEndpoint": "<your_OpenAI_endpoint>",
        "azureOpenAIDeploymentName": "<your_deployment_name>"
  }
}'

Utwórz skrypt języka Python o nazwie quickstart.py i dołącz następujący kod. Zaktualizuj adres URL punktu końcowego i klucz zgodnie z potrzebami:


conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview")
payload = json.dumps({
  "domain": "Generic",
  "task": "Summarization",
  "text": "The patient name is Kevin.",
  "groundingSources": [
    "The patient name is Jane."
  ],
  "correction": True,
  "llmResource": {
   "resourceType": "AzureOpenAI",
   "azureOpenAIEndpoint": "<your_OpenAI_endpoint>",
   "azureOpenAIDeploymentName": "<your_deployment_name>"
  }
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your_subscription_key>',
  'Content-Type': 'application/json'
}
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Parametry w treści żądania są zdefiniowane w tej tabeli:

Nazwa/nazwisko	opis	Type
domena	(Opcjonalnie) `MEDICAL` lub `GENERIC`. Wartość domyślna: `GENERIC`.	Wyliczenie
zadanie	(Opcjonalnie) Typ zadania: `QnA`, `Summarization`. Wartość domyślna: `Summarization`.	Wyliczenie
qna	(Opcjonalnie) Przechowuje dane usługi QnA, gdy typ zadania to `QnA`.	String
- `query`	(Opcjonalnie) Reprezentuje to pytanie w zadaniu pytań i odpowiedzi. Limit znaków: 7500.	String
text	(Wymagane) Tekst wyjściowy llM, który ma zostać sprawdzony. Limit znaków: 7500.	String
groundingSources	(Wymagane) Używa tablicy źródeł uziemienia do weryfikowania tekstu generowanego przez sztuczną inteligencję. Zobacz Wymagania dotyczące danych wejściowych, aby uzyskać informacje o limitach.	Tablica ciągów
korekta	(Opcjonalnie) Ustaw na `true`wartość , usługa używa zasobów usługi Azure OpenAI w celu zapewnienia poprawionego tekstu, zapewniając spójność ze źródłami uziemienia. Należy zachować ostrożność: użycie korekty zwiększa czas przetwarzania i wiąże się z dodatkowymi opłatami.	Wartość logiczna
llmResource	(Wymagane) Jeśli chcesz użyć własnego zasobu usługi Azure OpenAI GPT4o (0513, 0806 w wersji), aby włączyć rozumowanie, dodaj to pole i dołącz pola podrzędne dla używanych zasobów.	String
- `resourceType`	Określa typ używanego zasobu. Obecnie zezwala tylko na `AzureOpenAI`. Obsługujemy tylko zasoby usługi Azure OpenAI GPT4o (0513, 0806) i nie obsługują innych typów GPT.	Wyliczenie
- `azureOpenAIEndpoint`	Adres URL punktu końcowego dla usługi Azure OpenAI.	String
- `azureOpenAIDeploymentName`	Nazwa określonego wdrożenia GPT do użycia.	String

Interpretowanie odpowiedzi interfejsu API

Odpowiedź zawiera "correction Text" pole zawierające poprawiony tekst, zapewniając spójność z podanymi źródłami uziemienia.

Funkcja poprawek wykrywa, że Kevin jest nieprzystawiona, ponieważ powoduje konflikt ze źródłem Janeuziemienia . Interfejs API zwraca poprawiony tekst: "The patient name is Jane."

{
  "ungroundedDetected": true,
  "ungroundedPercentage": 1,
  "ungroundedDetails": [
    {
      "text": "The patient name is Kevin"
    }
  ],
  "correction Text": "The patient name is Jane"
}

Obiekty JSON w danych wyjściowych są zdefiniowane tutaj:

Nazwa/nazwisko	opis	Type
ungroundedDetected	Wskazuje, czy wykryto niezaziemowaną zawartość.	Wartość logiczna
ungroundedPercentage	Proporcja nieprzyziemnej zawartości w tekście.	Liczba zmiennoprzecinkowa
ungroundedDetails	Szczegóły nieprzyziemnej zawartości, w tym określone segmenty tekstu.	Tablica
-`text`	Określony tekst, który jest nieprzystawiony.	String
-`offset`	Obiekt opisujący położenie tekstu bez pola w różnych kodowaniu.	String
- `offset > utf8`	Położenie przesunięcia tekstu bez pola w kodowaniu UTF-8.	Integer
- `offset > utf16`	Położenie przesunięcia tekstu bez pola w kodowaniu UTF-16.	Integer
-`length`	Obiekt opisujący długość tekstu bez pola w różnych kodowaniu. (utf8, utf16, codePoint), podobnie jak przesunięcie.	Objekt
- `length > utf8`	Długość tekstu bez pola w kodowaniu UTF-8.	Integer
- `length > utf16`	Długość tekstu bez pola w kodowaniu UTF-16.	Integer
- `length > codePoint`	Długość tekstu bez pola pod względem punktów kodu Unicode.	Integer
-`correction Text`	Poprawiony tekst zapewniający spójność ze źródłami uziemienia.	String

Czyszczenie zasobów

Jeśli chcesz wyczyścić i usunąć subskrypcję usług Azure AI, możesz usunąć zasób lub grupę zasobów. Usunięcie grupy zasobów powoduje również usunięcie wszelkich innych skojarzonych z nią zasobów.

Pojęcia dotyczące wykrywania naziemności
Połącz wykrywanie uziemienia z innymi funkcjami bezpieczeństwa LLM, takimi jak Prompt Shields.

Udostępnij za pośrednictwem

Szybki start: korzystanie z wykrywania naziemności (wersja zapoznawcza)

Wymagania wstępne

Sprawdzanie uziemienia bez rozumowania

Interpretowanie odpowiedzi interfejsu API

Sprawdzanie uziemienia z rozumowaniem

Łączenie własnego wdrożenia GPT

Wysyłanie żądania interfejsu API

Interpretowanie odpowiedzi interfejsu API

Sprawdzanie uziemienia za pomocą funkcji korekty

Łączenie własnego wdrożenia GPT

Wysyłanie żądania interfejsu API

Interpretowanie odpowiedzi interfejsu API

Czyszczenie zasobów

Opinia

Dodatkowe zasoby

Udostępnij za pośrednictwem

Szybki start: korzystanie z wykrywania naziemności (wersja zapoznawcza)

Wymagania wstępne

Sprawdzanie uziemienia bez rozumowania

Interpretowanie odpowiedzi interfejsu API

Sprawdzanie uziemienia z rozumowaniem

Łączenie własnego wdrożenia GPT

Wysyłanie żądania interfejsu API

Interpretowanie odpowiedzi interfejsu API

Sprawdzanie uziemienia za pomocą funkcji korekty

Łączenie własnego wdrożenia GPT

Wysyłanie żądania interfejsu API

Interpretowanie odpowiedzi interfejsu API

Czyszczenie zasobów

Powiązana zawartość

Opinia

Dodatkowe zasoby