Guia de início rápido: categorias personalizadas (modo padrão) (visualização)

No comando abaixo, substitua <your_api_key>, <your_endpoint>, e outros parâmetros necessários por seus próprios valores. Em seguida, digite cada comando em uma janela do terminal e execute-o.

Criar nova versão de 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\"
        }"

Pedido à API

Resposta da API

Inicie o processo de construção da categoria:

Substitua <your_api_key> e <your_endpoint> por seus próprios valores e também acrescente o número da versão na url obtida na última etapa. Permita tempo suficiente para o treinamento do modelo: a execução de ponta a ponta do treinamento de categoria personalizada pode levar de cerca de cinco horas a dez horas. Planeje seu pipeline de moderação de acordo. Depois de receber a resposta, armazene o ID da operação (referido como id) em um local temporário. Esse ID será necessário para recuperar o status da compilação usando a API Get status na próxima seção.

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"

Resposta da API

Obtenha o status de compilação da categoria:

Para recuperar o status, utilize o id obtido da resposta anterior da API e coloque-o no caminho da API abaixo.

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"

Resposta da API

Analisar texto com uma categoria personalizada

Execute o seguinte comando para analisar o texto com sua categoria personalizada. Substitua <your_api_key> e <your_endpoint> com os seus próprios valores.

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

Pedido à API

Resposta da API

Primeiro, você precisa instalar a biblioteca Python necessária:

pip install requests

Em seguida, abra um novo script Python e defina as variáveis necessárias com seus próprios detalhes de recursos do Azure:

import requests

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

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

Criar uma nova categoria

Você pode criar uma nova categoria com nome, definição e sample_blob_url da categoria, e obterá o número de versão gerado automaticamente dessa 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)

Iniciar o processo de construção da categoria

Você pode iniciar o processo de compilação de categoria com o nome da categoria e o número da versão. Permita tempo suficiente para o treinamento do modelo: a execução de ponta a ponta do treinamento de categoria personalizada pode levar de cerca de cinco horas a dez horas. Planeje seu pipeline de moderação de acordo. Depois de receber a resposta, certifique-se de armazenar o ID da operação (referido como id) em algum lugar como seu bloco de anotações. Esse ID será necessário para recuperar o status da compilação usando a função 'get_build_status' na próxima seção.

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)

Obtenha o status de compilação da categoria:

Para recuperar o status, utilize o id obtido da resposta anterior.

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)

Analisar texto com uma categoria personalizada

Você precisa especificar o nome da categoria e o número da versão (opcional; o serviço usa o mais recente por padrão) durante a inferência. Você pode especificar várias categorias se elas já estiverem definidas.

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)

Obter uma categoria personalizada ou uma versão específica da mesma

Substitua os espaços reservados por seus próprios valores e execute o seguinte comando em uma janela do terminal:

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"

Listar categorias de suas versões mais recentes

Substitua os espaços reservados por seus próprios valores e execute o seguinte comando em uma janela do terminal:

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"

Excluir uma categoria personalizada ou uma versão específica dela

Substitua os espaços reservados por seus próprios valores e execute o seguinte comando em uma janela do terminal:

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"

Primeiro, certifique-se de ter instalado a biblioteca Python necessária:

pip install requests

Em seguida, configure as configurações necessárias com seus próprios detalhes de recursos de IA:

import requests

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

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

Obter uma categoria personalizada ou uma versão específica da mesma

Substitua os espaços reservados por seus próprios valores e execute o seguinte código em seu 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)

Listar categorias de suas versões mais recentes

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)

Excluir uma categoria personalizada ou uma versão específica dela

Substitua os espaços reservados por seus próprios valores e execute o seguinte código em seu 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)