> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mka1.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtenha uma visão geral de uma execução de avaliação

> Cabeçalho agregado para a visualização das tentativas de uma execução: contagem de tentativas, recompensa média, custo e a divisão de tokens de entrada/saída/cached. Sua própria rota em vez de campos no objeto de execução, porque ela varre as amostras da execução — incorporar isso em `GET /evals/runs/{run_id}` cobraria essa varredura em cada lista de execuções e na sondagem de status que roda durante toda a duração de um eval. `trials.errored` se sobrepõe a `trials.failed` em vez de particioná-lo: uma tentativa de agente de codificação pode registrar um timeout do agente em `error` e ainda assim ser concluída e pontuada. `trials.retried` conta as tentativas reexecutadas por meio de rerun-failed, lidas do snapshot anterior à nova execução, já que uma nova execução sobrescreve a amostra no lugar.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR get /api/v1/llm/evals/runs/{run_id}/overview
openapi: 3.1.1
info:
  title: MKA1 API
  version: 1.1.0
  description: >-
    A API MKA1 é uma API RESTful que fornece acesso à plataforma MKA1. Aprenda
    como começar a usar a API e o SDK TypeScript
    [aqui](https://mka1.apidocumentation.com/guides/getting-started).
  license:
    name: Proprietário
servers:
  - url: https://apigw.mka1.com
    description: MKA1 API Gateway
  - url: /
    description: Relative server URL (configurable via SDK constructor)
security: []
tags:
  - name: Resource Authorization
    description: >-
      Gerencie permissões para recursos LLM. Crie recursos, conceda/revoque
      permissões e exclua recursos. Apenas os proprietários dos recursos podem
      conceder, revogar ou excluir permissões.
    x-displayName: Autorização de Recurso
  - name: Embeddings
    description: >-
      Endpoints da API de incorporação de texto para gerar representações
      vetoriais de texto. Crie incorporações semânticas para busca, clustering e
      correspondência de similaridade usando vários modelos de incorporação.
    x-displayName: Incorporações
  - name: Feedback
    description: >-
      API de feedback do usuário para avaliar e comentar sobre as conclusões de
      chat. Coleta de classificações de positivo/negativo e feedback detalhado
      para melhorar as respostas do modelo e acompanhar a satisfação do usuário.
    x-displayName: Feedback
  - name: Images
    description: >-
      Pontos de extremidade da API de geração de imagens para criar imagens a
      partir de descrições de texto. Gere imagens com controle sobre tamanho,
      qualidade e estilo.
    x-displayName: Imagens
  - name: MCP Vault
    description: >-
      API do cofre MCP para armazenar configurações de servidor MCP de
      propriedade do usuário e credenciais criptografadas. Os agentes
      referenciam IDs de cofre para que os segredos sejam resolvidos apenas no
      momento da execução da ferramenta.
    x-displayName: Cofre MCP
  - name: Speech
    description: >-
      Pontos de extremidade da API de fala para processamento de áudio. Converta
      texto em fala com som natural (TTS) ou transcreva fala em texto (STT) em
      diferentes idiomas.
    x-displayName: Discurso
  - name: Usage
    description: >-
      API de rastreamento de uso e análise para monitoramento do consumo de
      tokens, contagem de solicitações e análise de custos. Veja estatísticas
      detalhadas por usuário, modelo e período de tempo.
    x-displayName: Uso
  - name: Extract
    description: >-
      API de extração de dados estruturados para extrair informações de
      arquivos. Defina esquemas JSON para extrair dados estruturados de imagens,
      PDFs e documentos. Suporta modelos de esquema reutilizáveis.
    x-displayName: Extração
  - name: Text Classification
    description: >-
      API de classificação de texto para categorizar textos em rótulos
      predefinidos. Use modelos de IA para classificar o conteúdo textual para
      análise de sentimento, categorização de tópicos e moderação de conteúdo.
    x-displayName: Classificação de Texto
  - name: Responses
    description: >-
      API de respostas com agentes para criar agentes de IA com uso autônomo de
      ferramentas. Crie assistentes conversacionais que podem usar pesquisa na
      web, operações de arquivos, geração de imagens, execução de código,
      simulação de uso de computador e integrações MCP. Suporta processamento em
      segundo plano, streaming e monitoramento de status em tempo real.
    x-displayName: Respostas
  - name: Files
    description: >-
      API de gerenciamento de arquivos para upload, armazenamento e
      gerenciamento de arquivos com expiração automática e integração com S3.
      Faça upload de arquivos que podem ser usados com Assistentes,
      Armazenamentos Vetoriais e outras funcionalidades. Os arquivos são
      armazenados no S3 com metadados rastreados no PostgreSQL. Suporta limpeza
      automática de arquivos expirados.
    x-displayName: Arquivos
  - name: Vector Stores
    description: >-
      API de armazenamento de vetores para armazenar e pesquisar documentos
      usando embeddings. Crie armazenamentos de vetores, faça upload de arquivos
      com divisão automática e geração de embeddings, e realize pesquisas
      semânticas. Os arquivos são processados de forma assíncrona usando fluxos
      de trabalho Temporais para durabilidade. Suporta limpeza automática de
      armazenamentos expirados e LanceDB para armazenamento eficiente de
      vetores.
    x-displayName: Armazenamentos de Vetores
  - name: Conversations
    description: >-
      API de gerenciamento de conversas para armazenar e recuperar o estado da
      conversa durante chamadas à API de Resposta. Crie conversas, adicione
      itens (mensagens do usuário, mensagens do assistente, mensagens do
      sistema) e mantenha o histórico da conversa. Suporta rastreamento de
      metadados e gerenciamento de estado de diálogo em múltiplas interações.
    x-displayName: Conversa
  - name: Guardrails
    description: >-
      API de diretrizes de segurança de IA para configurar moderação de conteúdo
      e políticas de segurança. Configure listas de palavras proibidas, detecção
      de injeção de prompts e prevenção de vazamento de prompts do sistema. As
      diretrizes aplicam-se a todas as solicitações de uma conta e podem ser
      testadas antes da implementação.
    x-displayName: Guarda-corpos
  - name: Models
    description: >-
      API de listagem de modelos para descobrir modelos disponíveis. Retorna IDs
      de modelos, propriedade e metadados de todos os modelos registrados no
      gateway.
    x-displayName: Modelos
  - name: Skills
    description: >-
      API de habilidades para gerenciar pacotes versionados de instruções e
      arquivos seguindo o padrão de Habilidades do Agente. Crie, versionar e
      baixe pacotes de habilidades reutilizáveis que incluam manifestos SKILL.md
      para ambientes de agentes.
    x-displayName: Habilidades
  - name: Chat Completions
    description: >-
      **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez
      disso.** Endpoints de conclusão de chat com suporte para streaming,
      chamadas de ferramentas e múltiplos provedores.
    x-deprecated: true
    x-displayName: Conclusões de Bate-Papo
  - name: Batches
    x-displayName: Lotes
  - name: Evals
    x-displayName: Avaliações
  - name: Fine-Tuning
    x-displayName: Ajuste Fino
  - name: Memory Stores
    x-displayName: Armazenamentos de Memória
  - name: Prompts
    x-displayName: Sugestões
  - name: API Key
    x-displayName: Chave da API
  - name: Session
    x-displayName: Sessão
  - name: Organization
    x-displayName: Organização
  - name: Cluster Admin
    x-displayName: Administrador do cluster
  - name: Sessions
    description: Crie, inspecione, acesse e encerre sessões de sandbox.
    x-displayName: Sessões
  - name: Browser
    description: >-
      Conecte-se às sessões do navegador através do proxy da porta do gateway.
      As sessões do navegador expõem um endpoint do Chrome DevTools Protocol na
      porta 9222.
    x-displayName: Navegador
  - name: Execution
    description: >-
      Executar comandos shell e código dentro de uma sessão de sandbox
      existente.
    x-displayName: Execução
  - name: Workspace
    description: >-
      Inspecione o manifesto do espaço de trabalho, transfira arquivos ou
      arquivos compactados e baixe artefatos gerados.
    x-displayName: Espaço de trabalho
  - name: Sandbox Usage
    description: >-
      Agregue estatísticas de uso da sandbox entre sessões, execução e operações
      do espaço de trabalho.
    x-displayName: Uso do Sandbox
  - name: Sandbox Pricing
    description: >-
      Gerenciamento de cluster-admin da tabela de preços de computação da
      sandbox usada para gastos orçados.
    x-displayName: Preço da Sandbox
  - name: schema-3_other
    x-displayName: outro
  - name: Agents
    description: Crie e gerencie definições de agentes reutilizáveis.
    x-displayName: Agentes
  - name: Agent Versions
    description: >-
      Inspecione o histórico de configuração de um agente e reverta para uma
      versão anterior.
    x-displayName: Versões do Agente
  - name: Agent Runs
    description: Execute agentes salvos e inspecione os resultados da execução persistidos.
    x-displayName: Executa Agente
  - name: Agent Connectors
    description: >-
      Conecte agentes salvos a canais de mensagens externos, como o Telegram,
      incluindo troca de texto, foto e documentos compatíveis.
    x-displayName: Conectores de Agente
  - name: Agent Schedules
    description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes.
    x-displayName: Agendas de Agentes
  - name: schema-4_other
    x-displayName: outro
  - name: Budgets
    x-displayName: Orçamentos
  - name: Settings
    x-displayName: Configurações
  - name: Compute Jobs
    x-displayName: Jobs de Computação
  - name: Compute Services
    x-displayName: Serviços de Computação
  - name: Compute Catalog
    x-displayName: Catálogo de Computação
  - name: Compute Volumes
    x-displayName: Calcular volumes
  - name: Compute Pricing
    x-displayName: Calcular Preços
  - name: Compute Secrets
    x-displayName: Calcular Segredos
  - name: Compute Usage
    x-displayName: Uso de Computação
  - name: Compute Tenants
    x-displayName: Calcular Inquilinos
  - description: Criar, listar, ler, atualizar e excluir repositórios.
    name: Repositories
    x-displayName: Repositórios
paths:
  /api/v1/llm/evals/runs/{run_id}/overview:
    get:
      tags:
        - Evals
      summary: Obtenha uma visão geral de uma execução de avaliação
      description: >-
        Cabeçalho agregado para a visualização das tentativas de uma execução:
        contagem de tentativas, recompensa média, custo e a divisão de tokens de
        entrada/saída/cached. Sua própria rota em vez de campos no objeto de
        execução, porque ela varre as amostras da execução — incorporar isso em
        `GET /evals/runs/{run_id}` cobraria essa varredura em cada lista de
        execuções e na sondagem de status que roda durante toda a duração de um
        eval. `trials.errored` se sobrepõe a `trials.failed` em vez de
        particioná-lo: uma tentativa de agente de codificação pode registrar um
        timeout do agente em `error` e ainda assim ser concluída e pontuada.
        `trials.retried` conta as tentativas reexecutadas por meio de
        rerun-failed, lidas do snapshot anterior à nova execução, já que uma
        nova execução sobrescreve a amostra no lugar.
      operationId: getEvalRunOverview
      parameters:
        - name: run_id
          in: path
          required: true
          schema:
            type: string
          example: eval_run_aa87e2b1112a455b8deabed784372198
        - name: metric
          in: query
          schema:
            type: string
            maxLength: 128
            pattern: ^[\w.-]+$
            default: reward
            description: >-
              A chave `avg_reward` de `scores` faz a média. O padrão é `reward`,
              que é o que o harness registra para uma tarefa de
              aprovação/reprovação.
          allowEmptyValue: true
          example: reward
        - name: X-On-Behalf-Of
          in: header
          required: false
          schema:
            type: string
          description: Optional external end-user identifier forwarded by the API gateway.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvalRunOverview'
              example:
                object: eval.run.overview
                run_id: eval_run_aa87e2b1112a455b8deabed784372198
                suite_id: eval_suite_aa87e2b1112a455b8deabed784372198
                status: completed
                agent_name: omp
                agent_version: 17.3.8
                agent_effort: medium
                models:
                  - meetkai:functionary-urdu-mini-pak
                metric: reward
                avg_reward: 0.539
                trials:
                  total: 89
                  completed: 89
                  failed: 0
                  errored: 3
                  retried: 0
                cost_usd: 3.77
                tokens:
                  input: 41233190
                  output: 1884022
                  cached: 41102336
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: python
          label: Python (SDK)
          source: |-
            from meetkai_mka1 import SDK


            with SDK(
                bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
            ) as sdk:

                res = sdk.llm.evals.get_run_overview(run_id="eval_run_aa87e2b1112a455b8deabed784372198", metric="reward")

                # Handle response
                print(res)
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { SDK } from "@meetkai/mka1";

            const sdk = new SDK({
              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            });

            async function run() {
              const result = await sdk.llm.evals.getRunOverview({
                runId: "eval_run_aa87e2b1112a455b8deabed784372198",
              });

              console.log(result);
            }

            run();
        - lang: csharp
          label: CSharp (SDK)
          source: |-
            using MeetKai.MKA1;
            using MeetKai.MKA1.Types.Components;

            var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

            var res = await sdk.Llm.Evals.GetRunOverviewAsync(
                runId: "eval_run_aa87e2b1112a455b8deabed784372198",
                metric: "reward"
            );

            // handle response
components:
  schemas:
    EvalRunOverview:
      type: object
      properties:
        object:
          const: eval.run.overview
        run_id:
          type: string
        suite_id:
          type: string
        status:
          $ref: '#/components/schemas/EvalRunStatus'
        agent_name:
          anyOf:
            - type: string
            - type: 'null'
        agent_version:
          anyOf:
            - type: string
            - type: 'null'
        agent_effort:
          anyOf:
            - type: string
            - type: 'null'
        models:
          type: array
          items:
            type: string
        metric:
          type: string
        avg_reward:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            Média de `metric` entre as tentativas que o contêm numericamente.
            Nulo quando nenhuma o contém.
        trials:
          type: object
          properties:
            total:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            completed:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            failed:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Testes no status `failed` — nenhuma pontuação produzida.
            errored:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: >-
                Testes com um `error` não nulo. Sobrepõe-se a `failed` em vez de
                particioná-lo: um teste de harness pode ter um timeout de agente
                e ainda assim ser concluído e pontuado.
            retried:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: >-
                Testes que foram executados novamente por meio de rerun-failed,
                contados a partir do snapshot pré-reexecução. 0 quando a
                execução nunca foi reexecutada.
          required:
            - total
            - completed
            - failed
            - errored
            - retried
        cost_usd:
          anyOf:
            - type: number
            - type: 'null'
        tokens:
          type: object
          properties:
            input:
              anyOf:
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: 'null'
            output:
              anyOf:
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: 'null'
            cached:
              anyOf:
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: 'null'
              description: >-
                Porcentagem de `input` atendido a partir do cache de prompt do
                provedor.
          required:
            - input
            - output
            - cached
          description: >-
            Somado ao longo das tentativas da execução. Cada campo é nulo quando
            nenhuma tentativa o informou.
      required:
        - object
        - run_id
        - suite_id
        - status
        - agent_name
        - agent_version
        - agent_effort
        - models
        - metric
        - avg_reward
        - trials
        - cost_usd
        - tokens
    EvalRunStatus:
      enum:
        - queued
        - in_progress
        - finalizing
        - completed
        - failed
        - cancelling
        - cancelled
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Gateway auth: send `Authorization: Bearer <mka1-api-key>`. For
        multi-user server-side integrations, you can also send `X-On-Behalf-Of:
        <external-user-id>`.

````