Referência de prévia da API REST de criação do OpenAI do Azure em Modelos do Microsoft Foundry

Este artigo fornece detalhes sobre a API REST de pontos de extremidade de inferência para o OpenAI do Azure.

Especificações da API

O gerenciamento e a interação com modelos e recursos do OpenAI do Azure são divididos em três superfícies principais da API:

• Painel de controle
• Plano de dados – criação
• Plano de dados – inferência

Cada superfície/especificação da API encapsula um conjunto diferente de recursos do OpenAI do Azure. Cada API tem seu próprio conjunto exclusivo de versões de API de versão prévia e estável/disponibilidade geral (GA). Atualmente, lançamentos de versões prévias tendem a seguir uma cadência mensal.

Autenticação

O OpenAI do Azure fornece dois métodos de autenticação. Você pode usar chaves de API ou o Microsoft Entra ID.

• Autenticação de chave de API: para esse tipo de autenticação, todas as solicitações de API deverão incluir a Chave de API no cabeçalho HTTP da api-key. O Início Rápido fornece um tutorial de como fazer chamadas com esse tipo de autenticação.

• Autenticação do Microsoft Entra ID: você pode autenticar uma chamada à API usando um token do Microsoft Entra. Os tokens de autenticação são incluídos em uma solicitação como o cabeçalho Authorization. O token fornecido deverá ser precedido por Bearer, por exemplo Bearer YOUR_AUTH_TOKEN. Você pode ler nosso guia de instruções sobre autenticação com o Microsoft Entra ID.

Controle de versão da API REST

As APIs de serviço são versões que usam o parâmetro de consulta api-version. Todas as versões seguem a estrutura de data AAAA-MM-DD. Por exemplo:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Criação de plano de dados

O restante do artigo aborda a versão prévia da especificação de inferência do plano de dados do Azure OpenAI. 2025-04-01-preview

Se você procura a documentação sobre a versão mais recente da API em GA, consulte a API de inferência do plano de dados em GA mais recente

Lote - Listar

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

Obtém uma lista de todos os lotes pertencentes ao recurso Azure OpenAI.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "object": "batch",
        "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
        "endpoint": "/chat/completions",
        "errors": null,
        "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
        "completion_window": "24h",
        "status": "completed",
        "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
        "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
        "created_at": 1646126127,
        "in_progress_at": 1646126130,
        "expires_at": 1646126170,
        "finalizing_at": 1646126134,
        "completed_at": 1646126136,
        "failed_at": null,
        "expired_at": null,
        "cancelling_at": null,
        "cancelled_at": null,
        "request_counts": {
          "total": 500,
          "completed": 400,
          "failed": 100
        },
        "first_id": "batch_abc123",
        "last_id": "batch_abc456",
        "metadata": {
          "batch_description": "Evaluation job"
        }
      }
    ],
    "object": "list"
  }
}

Lote - Criar

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

Cria e executa um lote de um arquivo carregado de solicitações.

A resposta inclui detalhes do trabalho enfileirado, incluindo o status do trabalho.

A ID do arquivo de resultado é adicionada à resposta após a conclusão.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Tipo de conteúdo: application/json

Respostas

Código de status: 201

Descrição: o lote foi criado com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

Respostas: Código de Status: 201

{
  "headers": {
    "deployment-enqueued-tokens": 1000,
    "deployment-maximum-enqueued-tokens": 5000
  },
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "validating",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 0,
      "completed": 0,
      "failed": 0
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Lote - Obter

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

Obtém detalhes de um único lote especificado pela ID de lote fornecida.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "completed",
    "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
    "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": 1646126134,
    "completed_at": 1646126136,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 400,
      "failed": 100
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Lote - Cancelar

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

Cancela o processamento do lote especificado pela ID de lote fornecida.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: o lote foi cancelado com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "cancelling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1646126138,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 100,
      "failed": 5
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Conclusão armazenada - Listar

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

Obtém a lista de conclusões armazenadas.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
        "model": "gpt-4o-mini-2024-07-18",
        "created": 1738193475,
        "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
        "usage": {
          "total_tokens": 25,
          "completion_tokens": 7,
          "prompt_tokens": 18
        },
        "seed": 123,
        "top_p": 1,
        "temperature": 1,
        "presence_penalty": 0,
        "frequency_penalty": 0,
        "system_fingerprint": "fp_f3927aa00d",
        "metadata": {
          "key_1": "val_1",
          "key_2": "val_2"
        },
        "choices": [
          {
            "index": 0,
            "message": {
              "content": "Hello, how are you?",
              "role": "assistant"
            },
            "finish_reason": "stop"
          }
        ]
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

Conclusão armazenada - Obter

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Obtém a conclusão armazenada pela ID de conclusão armazenada fornecida.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

Conclusão armazenada - Atualizar

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Atualize a conclusão armazenada pela ID de conclusão armazenada fornecida.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Tipo de conteúdo: application/json

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

Conclusão armazenada - Excluir

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Exclua a conclusão armazenada pela ID de conclusão armazenada fornecida.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: a conclusão armazenada foi excluída com sucesso.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion.deleted",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "deleted": true
  }
}

Conclusão armazenada - Getmessages

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

Obtém mensagens de conclusão armazenadas pela ID de conclusão armazenada fornecida.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "role": "user",
        "content": "Hello"
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

Avaliação – Obter lista

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

Liste as avaliações de um projeto.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: uma lista de avaliações

Exemplos

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval",
        "id": "eval_6801694950848190b10968bb628b651d",
        "data_source_config": {
          "type": "custom",
          "schema": {
            "type": "object",
            "properties": {
              "item": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string"
                  },
                  "A": {
                    "type": "string"
                  },
                  "B": {
                    "type": "string"
                  },
                  "C": {
                    "type": "string"
                  },
                  "D": {
                    "type": "string"
                  },
                  "answer": {
                    "type": "string"
                  }
                }
              }
            },
            "required": [
              "item"
            ]
          }
        },
        "testing_criteria": [
          {
            "name": "string check",
            "type": "string_check",
            "input": "{{sample.output_text}}",
            "reference": "{{item.answer}}",
            "operation": "eq"
          }
        ],
        "name": "Math Quiz",
        "created_at": 1744922953,
        "metadata": {}
      }
    ],
    "first_id": "eval_6801694950848190b10968bb628b651d",
    "last_id": "eval_6801694950848190b10968bb628b651d",
    "has_more": false
  }
}

Avaliação - Criar

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

Crie a estrutura de uma avaliação que pode ser usada para testar o desempenho de um modelo. Uma avaliação é um conjunto de critérios de teste e uma fonte de dados. Depois de criar uma avaliação, você pode executá-la em diferentes modelos e parâmetros de modelo. Oferecemos suporte a vários tipos de grades e fontes de dados.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de status: 201

Descrição: OK

Exemplos

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

{
 "name": "Math Quiz",
 "data_source_config": {
  "type": "custom",
  "include_sample_schema": true,
  "item_schema": {
   "type": "object",
   "properties": {
    "question": {
     "type": "string"
    },
    "A": {
     "type": "string"
    },
    "B": {
     "type": "string"
    },
    "C": {
     "type": "string"
    },
    "D": {
     "type": "string"
    },
    "answer": {
     "type": "string"
    }
   }
  }
 },
 "testing_criteria": [
  {
   "type": "string_check",
   "reference": "{{item.answer}}",
   "input": "{{sample.output_text}}",
   "operation": "eq",
   "name": "string check"
  }
 ]
}

Respostas: Código de Status: 201

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

Avaliação - Excluir

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Excluir uma avaliação.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: avaliação excluída com êxito.

Código de status: 404

Descrição: Avaliação não encontrada.

Exemplos

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "eval_id": "eval_6801694950848190b10968bb628b651d"
  }
}

Código de status: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation with ID eval_6801694950848190b10968bb628b651d not found."
  }
}

Avaliação - Obter

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Obter uma avaliação por ID.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: a avaliação

Exemplos

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

Avaliação – Atualizar

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Atualize determinadas propriedades de uma avaliação.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: a avaliação atualizada

Exemplos

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

{
 "name": "Updated Math Quiz",
 "metadata": {
  "description": "Updated description"
 }
}

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Updated Math Quiz",
    "created_at": 1744922953,
    "metadata": {
      "description": "Updated description"
    }
  }
}

Avaliação – Getrunlist

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Obter uma lista de execuções para uma avaliação.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: uma lista de execuções para a avaliação

Exemplos

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run",
        "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "report_url": "https://ai.azure.com/resource/evaluation",
        "status": "queued",
        "model": "gpt-4o-mini",
        "name": "Math quiz",
        "created_at": 1744923141,
        "result_counts": {
          "total": 0,
          "errored": 0,
          "failed": 0,
          "passed": 0
        },
        "per_model_usage": null,
        "per_testing_criteria_results": null,
        "data_source": {
          "type": "completions",
          "source": {
            "type": "file_content",
            "content": [
              {
                "item": {
                  "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
                  "A": "0",
                  "B": "4",
                  "C": "2",
                  "D": "6",
                  "answer": "B"
                }
              },
              {
                "item": {
                  "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
                  "A": "8",
                  "B": "2",
                  "C": "24",
                  "D": "120",
                  "answer": "C"
                }
              }
            ]
          },
          "input_messages": {
            "template": [
              {
                "type": "message",
                "role": "system",
                "content": {
                  "text": "Answer the question's with A, B, C, or D."
                }
              },
              {
                "type": "message",
                "role": "user",
                "content": {
                  "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
                }
              }
            ]
          },
          "model": "gpt-4o-mini",
          "sampling_params": {
            "seed": 42,
            "temperature": 1,
            "top_p": 1
          }
        },
        "error": null,
        "metadata": {}
      }
    ],
    "first_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "last_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "has_more": false
  }
}

Avaliação - Criar execução

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Criar uma execução de avaliação. Este é o ponto de extremidade que iniciará a classificação.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de status: 201

Descrição: execução criada com êxito para a avaliação

Código de status: 400

Descrição: Solicitação incorreta (por exemplo, objeto de avaliação ausente)

Exemplos

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

{
 "name": "Math quiz",
 "data_source": {
  "type": "completions",
  "source": {
   "type": "file_content",
   "content": [
    {
     "item": {
      "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
      "A": "0",
      "B": "4",
      "C": "2",
      "D": "6",
      "answer": "B"
     }
    },
    {
     "item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
     }
    }
   ]
  },
  "input_messages": {
   "type": "template",
   "template": [
    {
     "type": "message",
     "role": "system",
     "content": {
      "text": "Answer the question's with A, B, C, or D."
     }
    },
    {
     "type": "message",
     "role": "user",
     "content": {
      "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
     }
    }
   ]
  },
  "model": "gpt-4o-mini",
  "sampling_params": {
   "temperature": 1,
   "top_p": 1,
   "seed": 42
  }
 }
}

Respostas: Código de Status: 201

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Avaliação - Excluir execução

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Excluir uma execução de avaliação.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: a execução do teste foi excluída com sucesso

Código de status: 404

Descrição: Tarefa não encontrada

Exemplos

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3"
  }
}

Código de status: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation Run with ID evalrun_68016a056f0481909b9774447bdd1aa3 not found."
  }
}

Avaliação - Obter execução

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Obter uma execução de avaliação por ID.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: a realização da avaliação

Exemplos

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Avaliação - Cancelar execução

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Cancelar uma execução de avaliação em andamento.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Objeto de execução de avaliação cancelada

Exemplos

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "canceled",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Avaliação - Obter itens de saída da execução

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

Obtenha uma lista de itens de saída para um processo de avaliação.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: uma lista de itens de saída para a execução da avaliação

Exemplos

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run.output_item",
        "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
        "created_at": 1744925265,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 1,
        "datasource_item": {
          "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
          "A": "8",
          "B": "2",
          "C": "24",
          "D": "120",
          "answer": "C"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. ",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 627,
            "completion_tokens": 546,
            "prompt_tokens": 81,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      },
      {
        "object": "eval.run.output_item",
        "id": "outputitem_6801724f54888190942ec66a197309dd",
        "created_at": 1744925263,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 0,
        "datasource_item": {
          "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
          "A": "0",
          "B": "4",
          "C": "2",
          "D": "6",
          "answer": "B"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q. A: 0 B: 4 C: 2 D: 6.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\), we can simplify \\(\\sqrt{18}\\) since \\(\\sqrt{18} = \\sqrt{9 \\cdot 2} = 3\\sqrt{2}\\). \n\nThus, the field can be rewritten as \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\).\n\nNext, we calculate the degree of the extensions step by step:\n\n1. The extension \\(\\mathbb{Q}(\\sqrt{2})\\) over \\(\\mathbb{Q}\\) has degree 2, since \\(\\sqrt{2}\\) is not in \\(\\mathbb{Q}\\) and satisfies the polynomial \\(x^2 - 2\\).\n\n2. Next, we consider the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\). The element \\(\\sqrt{3}\\) is also not in \\(\\mathbb{Q}(\\sqrt{2})\\) and satisfies the polynomial \\(x^2 - 3\\), which is irreducible over \\(\\mathbb{Q}(\\sqrt{2})\\). Hence, the degree of the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\) is also 2.\n\nNow we can combine these degrees:\n\n\\[\n[\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}] = [\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}(\\sqrt{2})] \\times [\\mathbb{Q}(\\sqrt{2}) : \\mathbb{Q}] = 2 \\times 2 = 4.\n\\]\n\nThus, the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\) is 4.\n\nTherefore, the answer is:\n\n**B: 4**.",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 556,
            "completion_tokens": 487,
            "prompt_tokens": 69,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      }
    ],
    "first_id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "last_id": "outputitem_6801724f54888190942ec66a197309dd",
    "has_more": false
  }
}

Avaliação - Obter item de saída da execução

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

Obter um item de saída da execução de avaliação por ID.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: o item de saída da execução de avaliação

Exemplos

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "eval.run.output_item",
    "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "created_at": 1744925265,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "status": "fail",
    "datasource_item_id": 1,
    "datasource_item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
    },
    "results": [
      {
        "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
        "sample": null,
        "passed": false,
        "score": 0
      }
    ],
    "sample": {
      "input": [
        {
          "role": "system",
          "content": "Answer the question's with A, B, C, or D."
        },
        {
          "role": "user",
          "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120."
        }
      ],
      "output": [
        {
          "role": "assistant",
          "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. "
        }
      ],
      "finish_reason": "stop",
      "model": "gpt-4o-mini-2024-07-18",
      "usage": {
        "total_tokens": 627,
        "completion_tokens": 546,
        "prompt_tokens": 81,
        "cached_tokens": 0
      },
      "error": null,
      "temperature": 1,
      "top_p": 1,
      "seed": 42
    }
  }
}

Arquivos – Lista

GET {endpoint}/openai/files?api-version=2025-04-01-preview

Obtém uma lista de todos os arquivos pertencentes ao recurso Azure OpenAI.

Isso inclui o conteúdo carregado pelo usuário, como arquivos com a finalidade de "ajustar finamente" para treinamento ou validação de modelos de ajuste fino, bem como arquivos gerados pelo serviço, como "resultados de ajuste fino" que contêm várias métricas para o trabalho de ajuste fino correspondente.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/files?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "processed",
        "bytes": 140,
        "purpose": "fine-tune",
        "filename": "puppy.jsonl",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      },
      {
        "status": "processed",
        "bytes": 32423,
        "purpose": "fine-tune-results",
        "filename": "results.csv",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      }
    ],
    "object": "list"
  }
}

Arquivos – Carregar

POST {endpoint}/openai/files?api-version=2025-04-01-preview

Cria uma nova entidade de arquivo carregando dados de um computador local. Arquivos carregados podem, por exemplo, ser usados para treinamento ou avaliação de modelos ajustados.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Content-Type: multipart/form-data

Respostas

Código de status: 201

Descrição: o arquivo foi criado com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/files?api-version=2025-04-01-preview

Respostas: Código de Status: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Arquivos – Importar

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

Cria uma nova entidade de arquivo importando dados de uma URL fornecida. Arquivos carregados podem, por exemplo, ser usados para treinamento ou avaliação de modelos ajustados.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Tipo de conteúdo: application/json

Respostas

Código de status: 201

Descrição: o arquivo foi criado com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

Respostas: Código de Status: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Arquivos - Obter

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Obtém detalhes de um único arquivo especificado pela ID de arquivo fornecida, incluindo status, tamanho, finalidade etc.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "status": "processed",
    "bytes": 140,
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Arquivos – Excluir

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Exclui o arquivo com a ID de arquivo fornecida.

A exclusão também será permitida se um arquivo tiver sido usado, por exemplo, como arquivo de treinamento em um trabalho de ajuste fino.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: o arquivo foi excluído com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "object": "file",
    "deleted": true,
    "id": "file-181a1cbdcdcf4677ada87f63a0928099"
  }
}

Arquivos – Obter conteúdo

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

Obtém o conteúdo do arquivo especificado pela ID de arquivo fornecida.

Os arquivos podem ser carregados pelo usuário ou gerados pelo serviço, como métricas de resultado de um trabalho de ajuste fino.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": "raw file content"
}

Ajuste fino - Listar

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Obtém uma lista de todos os trabalhos de ajuste fino pertencentes ao recurso do Azure OpenAI. Os detalhes retornados para cada trabalho de ajuste fino contêm além de seu identificador o modelo base, arquivos de treinamento e validação, hiper parâmetros, carimbos de data/hora, status e eventos.

Os eventos são criados quando o status do trabalho é alterado. Por exemplo, execução ou conclusão e quando os resultados são carregados.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "hyperparameters": {
          "n_epochs": -1
        },
        "integrations": [
          {
            "type": "wandb",
            "wandb": {
              "project": "custom-wandb-project",
              "tags": [
                "project:tag",
                "lineage"
              ]
            }
          }
        ],
        "method": {
          "type": "supervised"
        },
        "status": "succeeded",
        "model": "curie",
        "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
        "result_files": [
          "file-181a1cbdcdcf4677ada87f63a0928099"
        ],
        "finished_at": 1646127311,
        "trained_tokens": 2342,
        "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "fine_tuning.job"
      }
    ],
    "object": "list"
  }
}

Ajuste fino - Criar

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Cria um trabalho que ajusta um modelo especificado de um determinado arquivo de treinamento.

A resposta inclui detalhes do trabalho enfileirado, incluindo status do trabalho e hiper parâmetros.

O nome do modelo ajustado é adicionado à resposta após a conclusão.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Tipo de conteúdo: application/json

Respostas

Código de status: 201

Descrição: o ajuste fino foi criado com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Respostas: Código de Status: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "pending",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Obter

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Obter detalhes de um único trabalho de ajuste fino especificado pelo ID de ajuste fino fornecido.

Os detalhes contêm o modelo base, arquivos de treinamento e validação, hiper parâmetros, carimbos de data/hora, status e eventos.

Os eventos são criados quando o status do trabalho é alterado, por exemplo, em execução ou concluído e quando os resultados são carregados.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "succeeded",
    "model": "curie",
    "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "result_files": [
      "file-181a1cbdcdcf4677ada87f63a0928099"
    ],
    "finished_at": 1646127311,
    "trained_tokens": 2342,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Excluir

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Exclui o trabalho de ajuste fino especificado pelo ID de ajuste fino fornecido.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de status: 204

Descrição: o ajuste fino foi excluído com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 204

{
  "headers": {}
}

Ajuste avançado – Cancelar

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

Cancela o processamento do trabalho de ajuste fino especificado pelo ID de ajuste fino fornecido.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: o ajuste fino foi cancelado com êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "cancelled",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Obter pontos de verificação

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

Obtém os pontos de verificação do trabalho de ajuste fino especificado pelo ID de ajuste fino fornecido.

Os pontos de verificação são criados ao final de épocas bem-sucedidas durante o treinamento.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P",
        "created_at": 1646126127,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10",
        "step_number": 10,
        "metrics": {
          "step": 10,
          "train_loss": 0.478,
          "train_mean_token_accuracy": 0.924,
          "valid_loss": 10.112,
          "valid_mean_token_accuracy": 0.145,
          "full_valid_loss": 0.567,
          "full_valid_mean_token_accuracy": 0.944
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_frtXDR2453C4FG67t03MLPs5",
        "created_at": 1646126137,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20",
        "step_number": 20,
        "metrics": {
          "step": 20,
          "train_loss": 0.355,
          "train_mean_token_accuracy": 0.947,
          "valid_loss": 11.32,
          "valid_mean_token_accuracy": 0.122,
          "full_valid_loss": 0.317,
          "full_valid_mean_token_accuracy": 0.955
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_agLk6Gio560ORp14gl123fgd",
        "created_at": 1646126147,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30",
        "step_number": 30,
        "metrics": {
          "step": 30,
          "train_loss": 0.155,
          "train_mean_token_accuracy": 0.975,
          "valid_loss": 9.31,
          "valid_mean_token_accuracy": 0.092,
          "full_valid_loss": 0.114,
          "full_valid_mean_token_accuracy": 0.963
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      }
    ],
    "object": "list"
  }
}

Ajuste fino - Obter eventos

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

Obtém os eventos do trabalho de ajuste fino especificado pelo ID de ajuste fino fornecido.

Os eventos são criados quando o status do trabalho é alterado, por exemplo, em execução ou concluído e quando os resultados são carregados.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05",
        "created_at": 1646126127,
        "level": "info",
        "message": "Job enqueued. Waiting for jobs ahead to complete.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f",
        "created_at": 1646126169,
        "level": "info",
        "message": "Job started.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-2d47d651d2f3484c8187c88c00078147",
        "created_at": 1646126192,
        "level": "info",
        "message": "Job succeeded.",
        "type": "message",
        "object": "fine_tuning.job.event"
      }
    ],
    "object": "list"
  }
}

Ajuste detalhado – Pausar

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

Colocando em pausa o processamento do trabalho de ajuste fino especificado pelo ID de ajuste fino fornecido.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: o ajuste fino foi colocado em pausa com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "paused",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Retomar

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

Retoma o processamento do trabalho de ajuste fino especificado pelo ID de ajuste fino fornecido.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: o ajuste fino foi retomado com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "resuming",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Trabalhos de ingestão - Listar

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

Lista os trabalhos de ingestão.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "body": {
    "value": [
      {
        "jobId": "usercompute-ingestion-job",
        "kind": "UserCompute",
        "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
      },
      {
        "jobId": "syscompute-ingestion-job",
        "kind": "SystemCompute"
      }
    ]
  }
}

Trabalhos de ingestão - Criar

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Cria um trabalho de ingestão com a ID do trabalho especificada.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Tipo de conteúdo: application/json

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "SystemCompute",
    "jobId": "ingestion-job",
    "searchServiceConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://aykame-dev-search.search.windows.net"
    },
    "datasource": {
      "kind": "Storage",
      "connection": {
        "kind": "EndpointWithManagedIdentity",
        "endpoint": "https://mystorage.blob.core.windows.net/",
        "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
      },
      "containerName": "container",
      "chunking": {
        "maxChunkSizeInTokens": 2048
      },
      "embeddings": [
        {
          "connection": {
            "kind": "RelativeConnection"
          },
          "deploymentName": "Ada"
        }
      ]
    },
    "dataRefreshIntervalInHours": 24,
    "completionAction": "keepAllAssets"
  }
}

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Trabalhos de ingestão - Obter

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Obtém os detalhes da ID do trabalho especificada.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Execuções de trabalhos de ingestão - Listar

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

Lista as execuções da ID do trabalho especificada.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "body": {
    "value": [
      {
        "jobId": "ingestion-job",
        "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036",
        "status": "succeeded"
      },
      {
        "jobId": "ingestion-job",
        "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd",
        "status": "failed"
      },
      {
        "jobId": "ingestion-job",
        "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
        "status": "running"
      }
    ]
  }
}

Execuções de trabalhos de ingestão - Obter

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

Obtém os detalhes da ID de execução especificada como parte da ID do trabalho especificada.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "body": {
    "jobId": "ingestion-job",
    "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
    "status": "running",
    "progress": {
      "stageProgress": [
        {
          "name": "Preprocessing",
          "totalItems": 14,
          "processedItems": 0,
          "state": "notRunning"
        },
        {
          "name": "Indexing",
          "state": "notRunning"
        }
      ]
    }
  }
}

Modelos – Lista

GET {endpoint}/openai/models?api-version=2025-04-01-preview

Obtém uma lista de todos os modelos acessíveis pelo recurso do Azure OpenAI.

Eles incluem modelos base, bem como todos os modelos ajustados com êxito pertencentes ao recurso Azure OpenAI.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/models?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "succeeded",
        "capabilities": {
          "fine_tune": true,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "fine_tune": 1677662127,
          "inference": 1709284527
        },
        "id": "curie",
        "created_at": 1646126127,
        "object": "model"
      },
      {
        "status": "succeeded",
        "model": "curie",
        "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "capabilities": {
          "fine_tune": false,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "inference": 1709284527
        },
        "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "model"
      }
    ],
    "object": "list"
  }
}

Modelos - Obter

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Obtém detalhes do modelo especificado pela modelId fornecida.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "capabilities": {
      "fine_tune": true,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "fine_tune": 1677662127,
      "inference": 1709284527
    },
    "id": "curie",
    "created_at": 1646126127,
    "object": "model"
  }
}

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "model": "curie",
    "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "capabilities": {
      "fine_tune": false,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "inference": 1709284527
    },
    "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "model"
  }
}

Carregar arquivo – Iniciar

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

Um objeto de upload intermediário é criado, permitindo que você adicione Partes a ele. Atualmente, um tamanho de carregamento pode ter no máximo 9 GB no total e expirará duas horas após ser criado.

Depois que o Upload for concluído, um objeto File será gerado, contendo todas as partes carregadas. Esse objeto File pode ser usado em nossa plataforma, assim como qualquer outro arquivo.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Tipo de conteúdo: application/json

Corpo da solicitação

Tipo de conteúdo: texto/json

Corpo da solicitação

Tipo de conteúdo: application/*+json

Respostas

Código de Status: 200

Descrição: o upload foi criado com êxito.

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

{
 "purpose": "fine-tune",
 "filename": "training_data_v21.jsonl",
 "bytes": 2097152,
 "mime_type": "application/json"
}

Respostas: Código de Status: 200

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "pending",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Carregar arquivo – Cancelar

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

Cancela o Upload e levará todas as partes carregadas a serem excluídas de forma assíncrona.

Nenhuma parte pode ser adicionada depois que um upload é cancelado.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "cancelled",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Carregar arquivo – Concluído

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

Isso conclui o Upload e o objeto Upload retornado contém um objeto File aninhado que está pronto para uso em toda a plataforma.

Você pode definir a ordem das Partes fornecendo uma lista ordenada de IDs de Parte.

O número total de bytes carregados deve corresponder ao tamanho especificado originalmente ao criar o objeto Upload.

Após essa operação, nenhuma parte adicional poderá ser adicionada depois que o Upload for concluído.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Tipo de conteúdo: application/json

Corpo da solicitação

Tipo de conteúdo: texto/json

Corpo da solicitação

Tipo de conteúdo: application/*+json

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

{
 "part_ids": [
  "LnmictL3p0u4LH/ko343nw==",
  "LmmictL3p0u4LH/ko343nw=="
 ]
}

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "completed",
    "expires_at": 1646133327,
    "file": {
      "status": "processed",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Carregar arquivo – Parte

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

Adiciona uma parte a um objeto upload, em que cada Parte representa um segmento do arquivo que você está carregando.

Cada Parte pode estar até o limite de tamanho padrão para upload de arquivo, com base na Finalidade do Arquivo. Você pode continuar adicionando Partes até atingir o limite de tamanho de carregamento de 9 GB.

Parâmetros de URI

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Corpo da solicitação

Content-Type: multipart/form-data

Respostas

Código de Status: 200

Descrição: Êxito

Código de Status: padrão

Descrição: ocorreu um erro.

Exemplos

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

Respostas: Código de Status: 200

{
  "headers": {},
  "body": {
    "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "azure_block_id": "LnmictL3p0u4LH/ko343nw==",
    "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload.part"
  }
}

Componentes

Índice de Busca do AzureAI

Índice da Pesquisa de IA do Azure.

BaseConnection

Uma conexão com um recurso.

Discriminador para BaseConnection

Esse componente usa a propriedade kind para discriminar entre diferentes tipos:

Lote

Define os valores de um lote.

Solicitação de Criação em Lote

Define a solicitação para criar um lote.

BatchErrorData

Informações de erro para uma falha em lote.

BatchErrors

Para lotes que falharam, isso conterá mais informações sobre a causa das falhas.

ContagensDeSolicitaçõesEmLote

A solicitação conta para status diferentes dentro do lote.

BatchOutputReference

A pasta de Armazenamento do Azure para armazenar a saída.

BatchStatus

O status de um lote.

BatchesList

Representa uma lista de lotes.

Capacidades

Os recursos de um modelo base ou de ajuste fino.

Opção

Mensagem de Escolha

ChunkingSettings

Configurações de agrupamento

Ação de Conclusão

A ação de conclusão.

Tipo de Computação

O tipo de computação.

ConnectionStringConnection

Conexão de cadeia de conexão.

Tipo de Conexão

O tipo de conexão.

Índice CosmosDB

Índice do CosmosDB.

CrawlingSettings

Configurações de rastreamento

CreateEvalCompletionsRunDataSource

Um objeto CompletionsRunDataSource que descreve uma configuração de amostragem de modelo.

CreateEvalCustomDataSourceConfig

Um objeto CustomDataSourceConfig que define o esquema da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão: – Usado para definir seus critérios de teste e – Quais dados são necessários ao criar uma execução

CriarItemDeAvaliação

Uma mensagem de chat que compõe o prompt ou contexto. Pode incluir referências variáveis ao namespace "item", ou seja, {{item.name}}.

CreateEvalJsonlRunDataSource

Um objeto JsonlRunDataSource com o qual especifica um arquivo JSONL que corresponde à avaliação

CreateEvalLabelModelGrader

Um objeto LabelModelGrader que usa um modelo para atribuir rótulos a cada item na avaliação.

CreateEvalLogsDataSourceConfig

Uma configuração de fonte de dados que especifica a propriedade de metadados da sua consulta de conclusões armazenadas. Geralmente, são metadados como usecase=chatbot ou prompt-version=v2etc.

CriarSolicitacaoDeAvaliacao

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

Uma configuração StoredCompletionsRunDataSource que descreve um conjunto de filtros

CustomCompute, um serviço de computação personalizada

Computação personalizada.

DeploymentConnection

Conexão de implantação relativa.

Reprovação

Define as datas de substituição para os diferentes casos de uso de um modelo.

Normalmente, os modelos base dão suporte a 1 ano de ajuste fino após a criação. Normalmente, há suporte para inferência 2 anos após a criação de modelos base ou ajustados. As datas exatas são especificadas nas propriedades.

DpoHyperparamsRequest

Hiperparâmetros para o método DPO de ajuste fino

DpoMethod

Solicitação de ajuste fino do método DPO

DpoMethodConfigRequest

Configuração para o método de ajuste fino dpo. Inclui hiperparâmetros específicos do DPO

DpoMethodRequest

Solicitação de ajuste fino do método DPO

EndpointKeyConnection

Conexão de chave de ponto de extremidade.

EndpointMIConnection

Conexão de Identidade Gerenciada do Ponto de Extremidade.

Erro

Conteúdo de erro conforme definido nas diretrizes do Microsoft REST.

Código de Erro

Códigos de erro conforme definido nas diretrizes do Microsoft REST.

Resposta de Erro

Resposta de erro conforme definido nas diretrizes do Microsoft REST.

Eval

Um objeto Eval com critérios de teste e configuração de fonte de dados. Uma avaliação representa uma tarefa a ser concluída na sua integração de LLM. Assim como:

• Melhorar a qualidade do meu chatbot
• Veja como meu chatbot lida bem com o suporte ao cliente
• Verifique se o o3-mini é melhor no meu caso de uso do que o gpt-4o

EvalApiError

Um objeto que representa uma resposta de erro da API de Eval.

EvalCustomDataSourceConfig

Um CustomDataSourceConfig que especifica o esquema dos seus namespaces item e, opcionalmente, sample. O esquema de resposta define a forma dos dados que serão: – Usado para definir seus critérios de teste e – Quais dados são necessários ao criar uma execução

EvalFileRunDataSource

Uma configuração FileRunDataSource com uma ID de arquivo

EvalItem

Uma mensagem de entrada para o modelo com uma função que indica a hierarquia de instruções a seguir. As instruções fornecidas com a função developer ou system têm precedência sobre as instruções fornecidas com a função user. Presume-se que as mensagens com a assistant função tenham sido geradas pelo modelo em interações anteriores.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

Um objeto LabelModelGrader que usa um modelo para atribuir rótulos a cada item na avaliação.