Azure OpenAI em Microsoft Foundry Models authoring REST API preview reference

Este artigo fornece detalhes sobre os endpoints da API REST de inferência para o Azure OpenAI.

API specs

A gestão e interação com modelos e recursos OpenAI do Azure está dividida em três superfícies principais de API:

• Control plane
• Plano de dados - autoria
• Plano de dados - inferência

Cada superfície/especificação API encapsula um conjunto diferente de capacidades do Azure OpenAI. Cada API tem o seu próprio conjunto único de pré-visualização e versões de APIs estáveis/geralmente disponíveis (GA). Atualmente, os lançamentos de pré-visualização tendem a seguir uma cadência mensal.

Authentication

O Azure OpenAI fornece dois métodos para autenticação. Pode usar API Keys ou Microsoft Entra ID.

• Autenticação de Chave API: Para este tipo de autenticação, todos os pedidos de API devem incluir a Chave API no api-key cabeçalho HTTP. O Quickstart fornece orientações sobre como fazer chamadas com este tipo de autenticação.

• Microsoft Entra ID: Pode autenticar uma chamada API usando um token Microsoft Entra. Os tokens de autenticação são incluídos num pedido como Authorization cabeçalho. O token fornecido deve ser precedido por Bearer, por exemplo Bearer YOUR_AUTH_TOKEN. Pode ler o nosso guia prático sobre autenticação com Microsoft Entra ID.

Versionamento da API REST

As APIs dos serviços são versionadas usando o api-version parâmetro de consulta. Todas as versões seguem a estrutura de datas YYYY-MM-DD. For example:

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

Criação de planos de dados

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

Se procura documentação sobre a última versão da API GA, consulte a API de inferência de planos de dados GA mais recente

Lote - Lista

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

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

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
  }
}

Batch - Criar

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

Cria e executa um lote a partir de um ficheiro carregado de pedidos.

A resposta inclui detalhes do trabalho em fila, incluindo o estado do trabalho.

O ID do ficheiro de resultado é adicionado à resposta uma vez concluído.

URI Parameters

Request Header

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

Request Body

Content-Type: application/json

Responses

Código de Estado: 201

Descrição: O lote foi criado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 para um único lote especificado pelo id de lote dado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
    }
  }
}

Batch - Cancelar

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

Cancela o processamento do lote especificado pelo batch-id indicado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: O lote foi cancelado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Lista

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

Obtém a lista de conclusãos armazenados.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 pelo id de conclusão armazenado dado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Atualização

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

Atualize a conclusão armazenada pelo ID de conclusão armazenado indicado.

URI Parameters

Request Header

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

Request Body

Content-Type: application/json

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Eliminar

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

Apagar a conclusão armazenada pelo id de conclusão armazenado indicado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: A conclusão armazenada foi eliminada com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 200

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

Completação armazenada - Getmessages

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

Recebe mensagens de conclusão armazenadas pelo ID de conclusão armazenado indicado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Lista de Obtenção

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

Liste avaliações para um projeto.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

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

Examples

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

Respostas: Código de Estado: 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 possa 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, pode executá-la em diferentes modelos e parâmetros do modelo. Apoiamos vários tipos de avaliadores e fontes de dados.

URI Parameters

Request Header

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

Responses

Código de Estado: 201

Description: OK

Examples

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 Estado: 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 - Eliminar

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

Apaga uma avaliação.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: Apaguei com sucesso a avaliação.

Código de Estado: 404

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

Examples

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

Respostas: Código de Estado: 200

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

Código de Estado: 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

Faça uma avaliação por ID.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: A avaliação

Examples

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

Respostas: Código de Estado: 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 - Atualização

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

Atualize certas propriedades de uma avaliação.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: A avaliação atualizada

Examples

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

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

Respostas: Código de Estado: 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

Pede uma lista de corridas para avaliação.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: Lista de corridas para a avaliação

Examples

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

Respostas: Código de Estado: 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 sequência

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

Crie uma nova avaliação. Este é o ponto final que vai iniciar a correção.

URI Parameters

Request Header

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

Responses

Código de Estado: 201

Descrição: Criou com sucesso uma corrida para a avaliação

Código de Estado: 400

Descrição: Pedido mau (por exemplo, objeto de avaliação em falta)

Examples

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 Estado: 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 - Execução de Apagar

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

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

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: Eliminei com sucesso a execução de avaliação

Código de Estado: 404

Descrição: Corrida não encontrada

Examples

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

Respostas: Código de Estado: 200

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

Código de Estado: 404

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

Avaliação - Correr

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

Faça uma avaliação feita pelo ID.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: A corrida de avaliação

Examples

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

Respostas: Código de Estado: 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

Cancele uma avaliação em curso.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: O objeto de execução de avaliação cancelada

Examples

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

Respostas: Código de Estado: 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 - Getrunoutputitems

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

Obtenha uma lista dos itens de saída para uma execução de avaliação.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

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

Examples

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

Respostas: Código de Estado: 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 - Getrunoutputitem

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

Faça uma execução de avaliação, item de saída por ID.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

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

Examples

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

Respostas: Código de Estado: 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
    }
  }
}

Ficheiros - Lista

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

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

Estes incluem conteúdos carregados pelo utilizador, como ficheiros com o propósito de "fine-tune" para treino ou validação de modelos de fine-tune, bem como ficheiros gerados pelo serviço, como "fine-tune-results", que contém várias métricas para o trabalho de fine-tuning correspondente.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
  }
}

Ficheiros - Upload

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

Cria uma nova entidade de ficheiro ao carregar dados de uma máquina local. Ficheiros carregados podem, por exemplo, ser usados para treinar ou avaliar modelos afinados.

URI Parameters

Request Header

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

Request Body

Content-Type: multipart/form-data

Responses

Código de Estado: 201

Descrição: O ficheiro foi criado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
  }
}

Ficheiros - Importação

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

Cria uma nova entidade de ficheiro ao importar dados de uma URL fornecida. Ficheiros carregados podem, por exemplo, ser usados para treinar ou avaliar modelos afinados.

URI Parameters

Request Header

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

Request Body

Content-Type: application/json

Responses

Código de Estado: 201

Descrição: O ficheiro foi criado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
  }
}

Ficheiros - Obter

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

Obtém detalhes de um único ficheiro especificado pelo identificador indicado, incluindo estado, tamanho, propósito, etc.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 200

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

Ficheiros - Eliminar

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

Apaga o ficheiro com o ficheiro-id indicado.

A eliminação também é permitida se um ficheiro foi usado, por exemplo, como ficheiro de treino numa tarefa de ajuste fino.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: O ficheiro foi apagado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 200

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

Ficheiros - Obter conteúdo

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

Obtém o conteúdo do ficheiro especificado pelo ficheiro indicado.

Os ficheiros podem ser conteúdos carregados pelo utilizador ou gerados pelo serviço, como métricas de resultados de um trabalho de ajuste fino.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 200

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

Ajuste fino - Lista

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 Azure OpenAI. Os detalhes que são devolvidos para cada tarefa de ajuste fino incluem, além do seu identificador, o modelo base, ficheiros de treino e validação, hiperparâmetros, carimbos temporais, estado e eventos.

Os eventos são criados quando o estado do trabalho muda. Por exemplo, em execução ou concluído, e quando os resultados são carregados.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 afina um modelo específico a partir de um dado ficheiro de treino.

A resposta inclui detalhes do trabalho em fila, incluindo o estado do trabalho e os parâmetros hiperativos.

O nome do modelo finamente ajustado é adicionado à resposta uma vez concluído.

URI Parameters

Request Header

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

Request Body

Content-Type: application/json

Responses

Código de Estado: 201

Descrição: O ajuste fino foi criado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Obtenha

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

Obtém detalhes para um único trabalho de afinação especificado pelo fine-tune-id dado.

Os detalhes contêm o modelo base, ficheiros de treino e validação, hiperparâmetros, carimbos temporais, estado e eventos.

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

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Eliminar

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

Elimina o trabalho de afinação especificado pelo fine-tune-id dado.

URI Parameters

Request Header

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

Responses

Código de Estado: 204

Descrição: O ajuste fino foi eliminado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 204

{
  "headers": {}
}

Ajuste fino - Cancelar

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

Cancela o processamento do trabalho de afinação especificado pelo fine-tune-id dado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: O ajuste fino foi cancelado com sucesso

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 controlo

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

Obtém os checkpoints para o trabalho de ajuste fino especificado pelo fine-tune-id dado.

Os pontos de controlo são criados no final de épocas bem-sucedidas durante o treino.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Obtenha eventos

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

Obtém os eventos para o trabalho de ajuste fino especificado pelo fine-tune-id dado.

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

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 fino - Pausa

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

Pausar o processamento do trabalho de afinação especificado pelo fine-tune-id dado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: O ajuste fino foi pausado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
  }
}

Afinamento fino - Currículo

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

Retoma o processamento do trabalho de afinação especificado pelo id de ajuste fino dado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Descrição: O ajuste fino foi retomado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
  }
}

Empregos em ingestão - Lista

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

Lista os trabalhos de ingestão.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
      }
    ]
  }
}

Empregos de ingestão - Criar

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

Cria um trabalho de ingestão com o ID de trabalho especificado.

URI Parameters

Request Header

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

Request Body

Content-Type: application/json

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 Estado: 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"
    }
  }
}

Empregos de ingestão - Obter

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

Obtém os detalhes do ID do trabalho especificado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
    }
  }
}

Ingestionjobruns - Lista

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

Lista as execuções do id de trabalho especificado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
      }
    ]
  }
}

Ingestionjobruns - Consultar

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

Obtém os detalhes do id de execução especificado como parte do id de trabalho especificado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 Azure OpenAI.

Estes incluem modelos base, bem como todos os modelos finos afinados concluídos com sucesso pertencentes ao recurso Azure OpenAI.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 - Obtenha

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

Obtém detalhes para o modelo especificado pelo modelId dado.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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 Estado: 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 ficheiro - Iniciar

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

É criado um objeto intermédio de Upload, permitindo adicionar Partes a ele. Atualmente, o tamanho de upload pode ser no máximo de 9 GB no total e expira duas horas após a criação.

Depois de concluído o Upload, será gerado um objeto Ficheiro, contendo todas as partes carregadas. Este objeto Ficheiro pode então ser usado em toda a nossa plataforma, tal como qualquer outro ficheiro.

URI Parameters

Request Header

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

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Código de Estado: 200

Descrição: O carregamento foi criado com sucesso.

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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 Estado: 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 ficheiro - Cancelar

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

Cancela o Upload e fará com que todas as partes carregadas sejam eliminadas de forma assíncrona.

Nenhuma Peça pode ser adicionada após o cancelamento de um Upload.

URI Parameters

Request Header

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

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 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"
  }
}

Ficheiro de upload - Completo

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

Isto completa o Upload, e o objeto Upload devolvido contém um objeto File aninhado que está pronto para uso em toda a plataforma.

Pode definir a ordem das Peças fornecendo uma lista ordenada dos IDs das Peças.

O número total de bytes carregados deve corresponder ao tamanho originalmente especificado na criação do objeto Upload.

Após esta operação, não podem ser adicionadas Peças adicionais após a conclusão do Upload.

URI Parameters

Request Header

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

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

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

Respostas: Código de Estado: 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"
  }
}

Ficheiro de upload - Parte

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

Adiciona uma Parte a um objeto de Upload, onde cada Peça representa um segmento do ficheiro que estás a carregar.

Cada Peça pode atingir o limite de tamanho padrão para carregamento de ficheiros, com base no Propósito do Ficheiro. Podes continuar a adicionar peças até atingires o limite de tamanho de upload de 9 GB.

URI Parameters

Request Header

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

Request Body

Content-Type: multipart/form-data

Responses

Código de Estado: 200

Description: Success

Código de Estado: padrão

Descrição: Ocorreu um erro.

Examples

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

Respostas: Código de Estado: 200

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

Components

AzureAISearchIndex

Pesquisa de IA do Azure Index.

BaseConnection

Uma ligação a um recurso.

Discriminador para BaseConnection

Este componente utiliza a propriedade kind para discriminar entre diferentes tipos:

Batch

Define os valores de um lote.

BatchCreateRequest

Define o pedido para criar um lote.

BatchErrorData

Informação de erro para uma falha no lote.

BatchErrors

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

BatchRequestCounts

O pedido conta para diferentes estados dentro do lote.

BatchOutputReference

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

BatchStatus

O estado de um lote.

BatchesList

Representa uma lista de lotes.

Capabilities

As capacidades de um modelo base ou de ajuste fino.

Choice

ChoiceMessage

ChunkingSettings

Chunking settings

CompletionAction

A ação de conclusão.

ComputeType

O tipo de computação.

ConnectionStringConnection

Ligação da corda de ligação.

ConnectionType

O tipo de ligação.

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

Crawling settings

CreateEvalCompletionsRunDataSource

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

CreateEvalCustomDataSourceConfig

Um objeto CustomDataSourceConfig que define o esquema para a fonte de dados usada na avaliação é executado. Este esquema é usado para definir a forma dos dados que serão: - Usados para definir os seus critérios de teste e - Que dados são necessários ao criar uma execução

CreateEvalItem

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

CreateEvalJsonlRunDataSource

Um objeto JsonlRunDataSource com isso especifica um ficheiro JSONL que corresponde à avaliação

CreateEvalLabelModelGrader

Um objeto LabelModelGrader que utiliza um modelo para atribuir etiquetas a cada item da avaliação.

CreateEvalLogsDataSourceConfig

Uma configuração de fonte de dados que especifica a propriedade de metadados da tua consulta de completação armazenada. Isto costuma ser metadados como usecase=chatbot ou prompt-version=v2, etc.

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

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

CustomCompute

Custom compute.

DeploymentConnection

Ligação relativa à implantação.

Deprecation

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

Normalmente, os modelos base suportam 1 ano de ajustes finos após a criação. A inferência é normalmente suportada 2 anos após a criação de modelos base ou finamente ajustados. As datas exatas são especificadas nas propriedades.

DpoHyperparamsRequest

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

DpoMethod

Pedido de afinação do método DPO

DpoMethodConfigRequest

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

DpoMethodRequest

Pedido de afinação do método DPO

EndpointKeyConnection

Ligação à chave de endpoint.

EndpointMIConnection

Ligação de Identidade Gerida de Endpoint.

Error

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

ErrorCode

Códigos de erro conforme definidos nas diretrizes Microsoft REST.

ErrorResponse

Resposta ao erro conforme definido nas diretrizes Microsoft REST.

Eval

Um objeto Eval com uma configuração de fonte de dados e critérios de teste. Uma Avaliação representa uma tarefa a realizar para a integração do seu LLM. Like:

• Melhorar a qualidade do meu chatbot
• Veja como o meu chatbot lida bem com o apoio ao cliente
• Verifica 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 Eval.

EvalCustomDataSourceConfig

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

EvalFileRunDataSource

Uma configuração do FileRunDataSource com um ID de ficheiro

EvalItem

Uma mensagem introduzida no modelo com um papel que indica a instrução seguindo a hierarquia. As instruções dadas com o developer papel ou system têm prioridade sobre as instruções dadas com o user papel. Presume-se que as mensagens com o assistant papel tenham sido geradas pelo modelo em interações anteriores.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

Um objeto LabelModelGrader que utiliza um modelo para atribuir etiquetas a cada item da avaliação.

EvalList

Um objeto que representa uma lista de avaliações.