> ## 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.

# Importar resultados históricos de avaliação do Hugging Face

> Importa amostras históricas simplificadas no estilo jsonl de resultados de avaliação de um repositório de dataset da Hugging Face para um formato de execução de suíte de avaliação concluída. Os agregados são recalculados a partir das amostras e incluem métricas de pontuação canônicas para placares.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR post /api/v1/llm/evals/imports/huggingface-results
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: Tables
    description: Gerenciar esquemas de tabelas, operações de dados, pesquisa e índices.
    x-displayName: Tabelas
  - name: Text Store
    description: >-
      Gerencie armazenamentos de texto com busca híbrida (vetorial + texto
      completo) e conjuntos de texto agrupados.
    x-displayName: Loja de Texto
  - name: GraphRAG
    description: >-
      Construa e consulte gráficos de conhecimento leves respaldados por Redis e
      LanceDB.
    x-displayName: GraphRAG
  - name: API Key
    x-displayName: Chave da API
  - 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
    x-displayName: Uso do Sandbox
  - 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 Schedules
    description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes.
    x-displayName: Agendas de Agentes
  - name: schema-5_other
    x-displayName: outro
paths:
  /api/v1/llm/evals/imports/huggingface-results:
    post:
      tags:
        - Evals
      summary: Importar resultados históricos de avaliação do Hugging Face
      description: >-
        Importa amostras históricas simplificadas no estilo jsonl de resultados
        de avaliação de um repositório de dataset da Hugging Face para um
        formato de execução de suíte de avaliação concluída. Os agregados são
        recalculados a partir das amostras e incluem métricas de pontuação
        canônicas para placares.
      operationId: importHistoricalEvalResults
      parameters:
        - name: X-HuggingFace-Token
          in: header
          required: true
          description: >-
            Caller-owned Hugging Face token with read access to the source
            dataset repository. Gateway does not use its server-side Hugging
            Face token for historical imports.
          schema:
            type: string
          example: hf_your_read_token
        - name: X-On-Behalf-Of
          in: header
          required: false
          schema:
            type: string
          description: Optional external end-user identifier forwarded by the API gateway.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportHistoricalEvalResultsRequest'
            example:
              source:
                type: huggingface
                repo: meetkai/lm-eval-harness-result
                revision: main
                path_prefix: qwen/ur/
              suite_name: MKA1 historical eval results
              create_missing_tasks: true
              metadata:
                owner: eval-team
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvalHistoricalImportObject'
              example:
                object: eval.import
                source:
                  type: huggingface
                  repo: meetkai/lm-eval-harness-result
                  revision: main
                suite_id: eval_suite_aa87e2b1112a455b8deabed784372198
                suite_version: 1
                created_suite: true
                created_suite_version: true
                dry_run: false
                discovered_files: 30
                imported_runs: 30
                skipped_runs: 0
                imported_samples: 8870
      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.import_historical_results(x_hugging_face_token="hf_your_read_token", source={
                    "path_prefix": "qwen/ur/",
                }, suite_name="MKA1 historical eval results", create_missing_tasks=True, dry_run=False, metadata={
                    "owner": "eval-team",
                })

                # 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.importHistoricalResults({
                xHuggingFaceToken: "hf_your_read_token",
                importHistoricalEvalResultsRequest: {
                  source: {
                    pathPrefix: "qwen/ur/",
                  },
                  suiteName: "MKA1 historical eval results",
                  metadata: {
                    "owner": "eval-team",
                  },
                },
              });

              console.log(result);
            }

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

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

            var res = await sdk.Llm.Evals.ImportHistoricalResultsAsync(
                xHuggingFaceToken: "hf_your_read_token",
                body: new MeetKai.MKA1.Types.Components.ImportHistoricalEvalResultsRequest() {
                    Source = new ImportHistoricalEvalResultsRequestSource() {
                        PathPrefix = "qwen/ur/",
                    },
                    SuiteName = "MKA1 historical eval results",
                    Metadata = new Dictionary<string, string>() {
                        { "owner", "eval-team" },
                    },
                }
            );

            // handle response
components:
  schemas:
    ImportHistoricalEvalResultsRequest:
      type: object
      properties:
        source:
          type: object
          properties:
            type:
              const: huggingface
              default: huggingface
            repo:
              type: string
              pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*\/[A-Za-z0-9][A-Za-z0-9_.-]*$
              default: meetkai/lm-eval-harness-result
            revision:
              type: string
              minLength: 1
              default: main
            path_prefix:
              type: string
              minLength: 1
            files:
              type: array
              minItems: 1
              maxItems: 100
              items:
                type: string
                minLength: 1
          default:
            type: huggingface
            repo: meetkai/lm-eval-harness-result
            revision: main
        suite_id:
          type: string
          description: >-
            Conjunto existente para importar. As tarefas ausentes são
            adicionadas como uma nova versão por padrão.
        suite_name:
          type: string
          minLength: 1
          maxLength: 255
          default: Historical lm-eval harness results
        suite_description:
          type: string
          maxLength: 10000
        create_missing_tasks:
          type: boolean
          default: true
        dry_run:
          type: boolean
          default: false
        limit_files:
          type: integer
          minimum: 1
          maximum: 100
          description: >-
            Número máximo de arquivos de resultado a serem importados do Hugging
            Face, limitado a 100. As importações de listagem de repositórios têm
            como padrão 50; importações explícitas de source.files não são
            limitadas, a menos que isso seja definido.
        metadata:
          type: object
          propertyNames:
            type: string
            maxLength: 64
          additionalProperties:
            type: string
            maxLength: 512
          default: {}
    EvalHistoricalImportObject:
      type: object
      properties:
        object:
          const: eval.import
        source:
          type: object
          properties:
            type:
              const: huggingface
            repo:
              type: string
            revision:
              type: string
          required:
            - type
            - repo
            - revision
        suite_id:
          type: string
        suite_version:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        created_suite:
          type: boolean
        created_suite_version:
          type: boolean
        dry_run:
          type: boolean
        discovered_files:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        imported_runs:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        skipped_runs:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        imported_samples:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      required:
        - object
        - source
        - suite_id
        - suite_version
        - created_suite
        - created_suite_version
        - dry_run
        - discovered_files
        - imported_runs
        - skipped_runs
        - imported_samples
  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>`.

````