Snabbstart: Identifiering av grundlighet (förhandsversion)

Artikel
04/09/2024

Följ den här guiden om du vill använda Azure AI Content Valv ty Groundedness Detection för att kontrollera om textsvaren från stora språkmodeller (LLM: er) är baserade i källmaterialet som tillhandahålls av användarna.

Förutsättningar

En Azure-prenumeration – Skapa en kostnadsfritt
När du har din Azure-prenumeration skapar du en content Valv ty-resurs i Azure-portalen för att hämta din nyckel och slutpunkt. Ange ett unikt namn för din resurs, välj din prenumeration och välj en resursgrupp, region som stöds (USA, östra 2, USA, västra, Sverige, centrala) och prisnivån som stöds. Välj sedan Skapa.
- Det tar några minuter att distribuera resursen. När det är klart går du till den nya resursen. I den vänstra rutan under Resurshantering väljer du API-nycklar och slutpunkter. Kopiera ett av prenumerationsnyckelvärdena och slutpunkten till en tillfällig plats för senare användning.
(Valfritt) Om du vill använda resonemangsfunktionen skapar du en Azure OpenAI Service-resurs med en GPT-modell distribuerad.
cURL eller Python installerat.

Kontrollera grunderna utan resonemang

I det enkla fallet utan resonemangsfunktionen klassificerar API:et för grundsidentifiering det inskickade innehållet som true eller false.

cURL
Python

Det här avsnittet går igenom en exempelbegäran med cURL. Klistra in kommandot nedan i en textredigerare och gör följande ändringar.

Ersätt <endpoint> med slutpunkts-URL:en som är associerad med resursen.
Ersätt <your_subscription_key> med en av nycklarna för resursen.

Alternativt kan du ersätta fälten "query" eller "text" i brödtexten med din egen text som du vill analysera.

curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-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
}'

Öppna en kommandotolk och kör kommandot cURL.

Skapa en ny Python-fil med namnet quickstart.py. Öppna den nya filen i önskad redigerare eller IDE.

Ersätt innehållet i quickstart.py med följande kod. Ange din slutpunkts-URL och nyckel i lämpliga fält. Alternativt kan du ersätta fälten "query" eller "text" i brödtexten med din egen text som du vill analysera.

import http.client
import json

conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-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": False
})
headers = {
  'Ocp-Apim-Subscription-Key': '<your_subscription_key>',
  'Content-Type': 'application/json'
}
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Viktigt!

Kom ihåg att ta bort nyckeln från koden när du är klar och publicera aldrig nyckeln offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter. Mer information finns i Azure Key Vault.

Kör programmet med python kommandot :
```
python quickstart.py
```
Vänta en stund för att få svaret.

Om du vill testa en sammanfattningsaktivitet i stället för en QnA-uppgift (frågesvar) använder du följande JSON-exempeltext:

{
    "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
}

Följande fält måste inkluderas i URL:en:

Namn	Obligatoriskt	Beskrivning	Typ
API-version	Obligatoriskt	Det här är den API-version som ska användas. Den aktuella versionen är: api-version=2024-02-15-preview. Exempel: `<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview`	String

Parametrarna i begärandetexten definieras i den här tabellen:

Name	beskrivning	Typ
Domän	(Valfritt) `MEDICAL` eller `GENERIC`. Standardvärde: `GENERIC`.	Enum
Uppgift	(Valfritt) Typ av aktivitet: `QnA`, `Summarization`. Standardvärde: `Summarization`.	Enum
qna	(Valfritt) Innehåller QnA-data när aktivitetstypen är `QnA`.	String
- `query`	(Valfritt) Detta representerar frågan i en QnA-uppgift. Teckengräns: 7 500.	String
text	(Krävs) DEN LLM-utdatatext som ska kontrolleras. Teckengräns: 7 500.	String
groundingSources	(Krävs) Använder en matris med jordningskällor för att verifiera AI-genererad text. Upp till 55 000 tecken jordningskällor kan analyseras i en enda begäran.	Strängmatris
Resonemang	(Valfritt) Anger om du vill använda resonemangsfunktionen. Standardvärdet är `false`. Om `true`måste du ta med dina egna Azure OpenAI GPT-4 Turbo-resurser för att ge en förklaring. Var försiktig: att använda resonemang ökar bearbetningstiden.	Booleskt

Tolka API-svaret

När du har skickat din begäran får du ett JSON-svar som återspeglar den groundedness-analys som utförts. Så här ser en typisk utdata ut:

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

JSON-objekten i utdata definieras här:

Name	beskrivning	Typ
ungroundedDetected	Anger om texten uppvisar ogrundad text.	Booleskt
ungroundedPercentage	Anger andelen av texten som identifieras som ogrundad, uttryckt som ett tal mellan 0 och 1, där 0 anger inget ogrundat innehåll och 1 anger helt ogrundat innehåll.	Flyttal
ungroundedDetails	Ger insikter om ogrundat innehåll med specifika exempel och procentandelar.	Matris
-`text`	Den specifika text som är ojordad.	String

Kontrollera grunderna i resonemanget

API:et för groundedness-identifiering ger möjlighet att inkludera resonemang i API-svaret. När resonemanget är aktiverat innehåller svaret ett "reasoning" fält som beskriver specifika instanser och förklaringar till eventuell upptäckt ogrundadhet. Var försiktig: att använda resonemang ökar bearbetningstiden och medför extra avgifter.

Ta med din egen GPT-distribution

Dricks

För närvarande stöder vi bara Azure OpenAI GPT-4 Turbo-resurser och stöder inte andra GPT-typer. Dina GPT-4 Turbo-resurser kan distribueras i valfri region. Vi rekommenderar dock att de finns i samma region som innehållssäkerhetsresurserna för att minimera potentiella svarstider.

Om du vill använda din Azure OpenAI GPT4-Turbo-resurs för att aktivera resonemangsfunktionen använder du Hanterad identitet för att ge din innehållsresurs Valv ty åtkomst till Azure OpenAI-resursen:

Aktivera hanterad identitet för Azure AI-innehåll Valv ty.

Gå till din Azure AI Content Valv ty-instans i Azure-portalen. Leta reda på avsnittet Identitet under kategorin Inställningar. Aktivera den systemtilldelade hanterade identiteten. Den här åtgärden ger din Azure AI Content Valv ty-instans en identitet som kan identifieras och användas i Azure för åtkomst till andra resurser.
Tilldela rollen till hanterad identitet.

Gå till din Azure OpenAI-instans och välj Lägg till rolltilldelning för att starta processen med att tilldela en Azure OpenAI-roll till Azure AI Content Valv ty-identiteten.

Välj rollen Användare eller Deltagare .

Gör API-begäran

I din begäran till API:et för groundedness-identifiering anger du "reasoning" brödtextparametern till trueoch anger de andra nödvändiga parametrarna:

 {
  "reasoning": true,
  "llmResource": {
    "resourceType": "AzureOpenAI",
    "azureOpenAIEndpoint": "<your_OpenAI_endpoint>",
    "azureOpenAIDeploymentName": "<your_deployment_name>"
  }
}

cURL
Python

Det här avsnittet går igenom en exempelbegäran med cURL. Klistra in kommandot nedan i en textredigerare och gör följande ändringar.

Ersätt <endpoint> med slutpunkts-URL:en som är associerad med resursen.
Ersätt <your_subscription_key> med en av nycklarna för resursen.

Alternativt kan du ersätta fälten "query" eller "text" i brödtexten med din egen text som du vill analysera.

curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-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>"
}'

Öppna en kommandotolk och kör kommandot cURL.

Skapa en ny Python-fil med namnet quickstart.py. Öppna den nya filen i önskad redigerare eller IDE.

import http.client
import json

conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-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-02-15-preview", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Kör programmet med python kommandot :
```
python quickstart.py
```
Vänta en stund för att få svaret.

Parametrarna i begärandetexten definieras i den här tabellen:

Name	beskrivning	Typ
Domän	(Valfritt) `MEDICAL` eller `GENERIC`. Standardvärde: `GENERIC`.	Enum
Uppgift	(Valfritt) Typ av aktivitet: `QnA`, `Summarization`. Standardvärde: `Summarization`.	Enum
qna	(Valfritt) Innehåller QnA-data när aktivitetstypen är `QnA`.	String
- `query`	(Valfritt) Detta representerar frågan i en QnA-uppgift. Teckengräns: 7 500.	String
text	(Krävs) DEN LLM-utdatatext som ska kontrolleras. Teckengräns: 7 500.	String
groundingSources	(Krävs) Använder en matris med jordningskällor för att verifiera AI-genererad text. Upp till 55 000 tecken jordningskällor kan analyseras i en enda begäran.	Strängmatris
Resonemang	(Valfritt) Ange till `true`använder tjänsten Azure OpenAI-resurser för att ge en förklaring. Var försiktig: att använda resonemang ökar bearbetningstiden och medför extra avgifter.	Booleskt
llmResource	(Krävs) Om du vill använda din egen Azure OpenAI GPT4-Turbo-resurs för att aktivera resonemang lägger du till det här fältet och inkluderar underfälten för de resurser som används.	String
- `resourceType`	Anger vilken typ av resurs som används. För närvarande tillåter `AzureOpenAI`den bara . Vi stöder endast Azure OpenAI GPT-4 Turbo-resurser och stöder inte andra GPT-typer. Dina GPT-4 Turbo-resurser kan distribueras i valfri region. Vi rekommenderar dock att de finns i samma region som innehållssäkerhetsresurserna för att minimera potentiella svarstider.	Enum
- `azureOpenAIEndpoint`	Din slutpunkts-URL för Azure OpenAI-tjänsten.	String
- `azureOpenAIDeploymentName`	Namnet på den specifika GPT-distribution som ska användas.	String

Tolka API-svaret

När du har skickat din begäran får du ett JSON-svar som återspeglar den groundedness-analys som utförts. Så här ser en typisk utdata ut:

{
    "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. "
        }
    ]
}

JSON-objekten i utdata definieras här:

Name	beskrivning	Typ
ungroundedDetected	Anger om texten uppvisar ogrundad text.	Booleskt
ungroundedPercentage	Anger andelen av texten som identifieras som ogrundad, uttryckt som ett tal mellan 0 och 1, där 0 anger inget ogrundat innehåll och 1 anger helt ogrundat innehåll.	Flyttal
ungroundedDetails	Ger insikter om ogrundat innehåll med specifika exempel och procentandelar.	Matris
-`text`	Den specifika text som är ojordad.	String
-`offset`	Ett objekt som beskriver positionen för den ogrundade texten i olika kodningar.	String
- `offset > utf8`	Förskjutningspositionen för den ogrundade texten i UTF-8-kodning.	Integer
- `offset > utf16`	Förskjutningspositionen för den ogrundade texten i UTF-16-kodning.	Integer
- `offset > codePoint`	Förskjutningspositionen för den ogrundade texten när det gäller Unicode-kodpunkter.	Integer
-`length`	Ett objekt som beskriver längden på den ogrundade texten i olika kodningar. (utf8, utf16, codePoint), liknande förskjutningen.	Objekt
- `length > utf8`	Längden på den ogrundade texten i UTF-8-kodning.	Integer
- `length > utf16`	Längden på den ogrundade texten i UTF-16-kodning.	Integer
- `length > codePoint`	Längden på den ogrundade texten när det gäller Unicode-kodpunkter.	Integer
-`reason`	Ger förklaringar till upptäckt ogrundadhet.	String

Rensa resurser

Om du vill rensa och ta bort en Azure AI-tjänstprenumeration kan du ta bort resursen eller resursgruppen. Om du tar bort resursgruppen tas även alla andra resurser som är associerade med den bort.

Nästa steg

Kombinera groundedness-identifiering med andra LLM-säkerhetsfunktioner som Prompt Shields.

Snabbstart för Prompt Shields

Snabbstart: Identifiering av grundlighet (förhandsversion)

Förutsättningar

Kontrollera grunderna utan resonemang

Tolka API-svaret

Kontrollera grunderna i resonemanget

Ta med din egen GPT-distribution

Gör API-begäran

Tolka API-svaret

Rensa resurser

Nästa steg

Ytterligare resurser