Avvio rapido: Categorie personalizzate (modalità standard) (anteprima)

Nei comandi seguenti sostituire <your_api_key>, <your_endpoint> e gli altri parametri necessari con valori personalizzati. Immettere quindi ogni comando in una finestra del terminale ed eseguirlo.

Creare una nuova versione della categoria

curl -X PUT "<your_endpoint>/contentsafety/text/categories/<your_category_name>?api-version=2024-09-15-preview" \
     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
     -H "Content-Type: application/json" \
     -d "{
            \"categoryName\": \"survival-advice\",
            \"definition\": \"text prompts about survival advice in camping/wilderness situations\",
            \"sampleBlobUrl\": \"https://<your-azure-storage-url>/example-container/survival-advice.jsonl\"
        }"

Richiesta API

Risposta API

Avviare il processo di compilazione della categoria:

Sostituire <your_api_key> e <your_endpoint> con i propri valori e aggiungere anche il numero di versione nell'URL ottenuto dall'ultimo passaggio. Tempo sufficiente per il training del modello: l'esecuzione end-to-end del training di categorie personalizzate può richiedere da circa cinque ore a dieci ore. Pianificare di conseguenza la pipeline di moderazione. Dopo aver ricevuto la risposta, archiviare l'ID operazione (denominato id) in una posizione temporanea. Questo ID sarà necessario per recuperare lo stato di compilazione con l'API Ottieni stato nella sezione successiva.

curl -X POST "<your_endpoint>/contentsafety/text/categories/survival-advice:build?api-version=2024-09-15-preview&version={version}" \
     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
     -H "Content-Type: application/json"

Risposta API

Ottenere lo stato di compilazione della categoria:

Per recuperare lo stato, usare l'oggetto id ottenuto dalla risposta dell’API precedente e inserirlo nel percorso dell'API seguente.

curl -X GET "<your_endpoint>/contentsafety/text/categories/operations/<id>?api-version=2024-09-15-preview" \
     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
     -H "Content-Type: application/json"

Risposta API

Analizzare il testo con una categoria personalizzata

Eseguire il comando seguente per analizzare il testo con la categoria personalizzata. Sostituire <your_api_key> e <your_endpoint> con valori personalizzati.

curl -X POST "<your_endpoint>/contentsafety/text:analyzeCustomCategory?api-version=2024-09-15-preview" \
     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
     -H "Content-Type: application/json" \
     -d "{
            \"text\": \"<Example text to analyze>\",
            \"categoryName\": \"survival-advice\", 
            \"version\": 1
        }"

Richiesta API

Risposta API

Prima di tutto, è necessario installare la libreria Python necessaria:

pip install requests

Aprire quindi un nuovo script Python e definire le variabili necessarie con i dettagli della risorsa di Azure:

import requests

API_KEY = '<your_api_key>'
ENDPOINT = '<your_endpoint>'

headers = {
    'Ocp-Apim-Subscription-Key': API_KEY,
    'Content-Type': 'application/json'
}

Creare una nuova categoria

È possibile creare una nuova categoria, specificando un nome categoria, una definizione e un sample_blob_url. Verrà restituito il numero di versione generato automaticamente di tale categoria.

def create_new_category_version(category_name, definition, sample_blob_url):
    url = f"{ENDPOINT}/contentsafety/text/categories/{category_name}?api-version=2024-09-15-preview"
    data = {
        "categoryName": category_name,
        "definition": definition,
        "sampleBlobUrl": sample_blob_url
    }
    response = requests.put(url, headers=headers, json=data)
    return response.json()

# Replace the parameters with your own values
category_name = "survival-advice"
definition = "text prompts about survival advice in camping/wilderness situations"
sample_blob_url = "https://<your-azure-storage-url>/example-container/survival-advice.jsonl"

result = create_new_category_version(category_name, definition, sample_blob_url)
print(result)

Avviare il processo di compilazione della categoria

È possibile avviare il processo di compilazione della categoria specificando il nome della categoria e il numero di versione. Lasciare tempo sufficiente per il training del modello: l'esecuzione end-to-end del training di categorie personalizzate può richiedere da circa cinque ore a dieci ore. Pianificare di conseguenza la pipeline di moderazione. Dopo aver ricevuto la risposta, assicurarsi di archiviare l'ID operazione (detto id) su un supporto simile al notebook. Questo ID sarà necessario per recuperare lo stato di compilazione con la funzione 'get_build_status' nella sezione successiva.

def trigger_category_build_process(category_name, version):
    url = f"{ENDPOINT}/contentsafety/text/categories/{category_name}:build?api-version=2024-09-15-preview&version={version}"
    response = requests.post(url, headers=headers)
    return response.status_code

# Replace the parameters with your own values
category_name = "survival-advice"
version = 1

result = trigger_category_build_process(category_name, version)
print(result)

Ottenere lo stato di compilazione della categoria:

Per recuperare lo stato, utilizzare l'oggetto id ottenuto dalla risposta precedente.

def get_build_status(id):
    url = f"{ENDPOINT}/contentsafety/text/categories/operations/{id}?api-version=2024-09-15-preview"
    response = requests.get(url, headers=headers)
    return response.status_code

# Replace the parameter with your own value
id = "your-operation-id"

result = get_build_status(id)
print(result)

Analizzare il testo con una categoria personalizzata

È necessario specificare il nome della categoria e il numero di versione (facoltativo; il servizio usa la versione più recente per impostazione predefinita) durante l'inferenza. È possibile specificare più categorie se sono già state definite.

def analyze_text_with_customized_category(text, category_name, version):
    url = f"{ENDPOINT}/contentsafety/text:analyzeCustomCategory?api-version=2024-09-15-preview"
    data = {
        "text": text,
        "categoryName": category_name,
        "version": version
    }
    response = requests.post(url, headers=headers, json=data)
    return response.json()

# Replace the parameters with your own values
text = "<Example text to analyze>"
category_name = "survival-advice"
version = 1

result = analyze_text_with_customized_category(text, category_name, version)
print(result)

Ottenere una categoria personalizzata o una sua versione specifica

Sostituire i segnaposto con valori personalizzati ed eseguire il comando seguente in una finestra del terminale:

curl -X GET "<endpoint>/contentsafety/text/categories/<your_category_name>?api-version=2024-09-15-preview&version=1" \
     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
     -H "Content-Type: application/json"

Elencare le categorie delle versioni più recenti

Sostituire i segnaposto con valori personalizzati ed eseguire il comando seguente in una finestra del terminale:

curl -X GET "<endpoint>/contentsafety/text/categories?api-version=2024-09-15-preview" \
     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
     -H "Content-Type: application/json"

Eliminare una categoria personalizzata o una sua versione specifica

Sostituire i segnaposto con valori personalizzati ed eseguire il comando seguente in una finestra del terminale:

curl -X DELETE "<endpoint>/contentsafety/text/categories/<your_category_name>?api-version=2024-09-15-preview&version=1" \
     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
     -H "Content-Type: application/json"

Prima di tutto, assicurarsi di aver installato la libreria Python necessaria:

pip install requests

Impostare quindi le configurazioni necessarie con i dettagli delle risorse di intelligenza artificiale personalizzati:

import requests

API_KEY = '<your_api_key>'
ENDPOINT = '<your_endpoint>'

headers = {
    'Ocp-Apim-Subscription-Key': API_KEY,
    'Content-Type': 'application/json'
}

Ottenere una categoria personalizzata o una sua versione specifica

Sostituire i segnaposto con valori personalizzati ed eseguire il codice seguente nello script Python:

def get_customized_category(category_name, version=None):
    url = f"{ENDPOINT}/contentsafety/text/categories/{category_name}?api-version=2024-09-15-preview"
    if version:
        url += f"&version={version}"
    
    response = requests.get(url, headers=headers)
    return response.json()

# Replace the parameters with your own values
category_name = "DrugAbuse"
version = 1

result = get_customized_category(category_name, version)
print(result)

Elencare le categorie delle versioni più recenti

def list_categories_latest_versions():
    url = f"{ENDPOINT}/contentsafety/text/categories?api-version=2024-09-15-preview"
    response = requests.get(url, headers=headers)
    return response.json()

result = list_categories_latest_versions()
print(result)

Eliminare una categoria personalizzata o una sua versione specifica

Sostituire i segnaposto con valori personalizzati ed eseguire il codice seguente nello script Python:

def delete_customized_category(category_name, version=None):
    url = f"{ENDPOINT}/contentsafety/text/categories/{category_name}?api-version=2024-09-15-preview"
    if version:
        url += f"&version={version}"
    
    response = requests.delete(url, headers=headers)
    return response.status_code

# Replace the parameters with your own values
category_name = "<your_category_name>"
version = 1

result = delete_customized_category(category_name, version)
print(result)