# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hugging Face Models API
  version: 1.0.0
extends: openapi/hugging-face-models-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/models'].get
  update:
    x-apievangelist-phrasing:
      intent: Search models on the Hub
      effect: read
      questions:
      - Can I search the Hugging Face Hub for models by keyword, task or library?
      - Which Hub models are tagged for a given pipeline task, sorted by downloads?
      - What is the maximum number of Hub models one search can return?
      instructions:
      - text: Search Hub models for {search}.
        slots:
          search: query.search
      - text: List Hub models for task {pipeline_tag} built with {library}, sorted by {sort}.
        slots:
          pipeline_tag: query.pipeline_tag
          library: query.library
          sort: query.sort
      - text: Show up to {limit} Hub models published by {author}.
        slots:
          limit: query.limit
          author: query.author
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models/{repo_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Hub details for one model repo
      effect: read
      questions:
      - What does the Hub know about a model repository, like its tags, files and downloads?
      - Who published a model repo and which pipeline task is it for?
      instructions:
      - text: Get the Hub model info for repo {repo_id}.
        slots:
          repo_id: path.repo_id
      - text: Show me the latest repository details of model {repo_id}.
        slots:
          repo_id: path.repo_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models/{repo_id}/revision/{revision}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a model's info at a specific revision
      effect: read
      questions:
      - Can I see what a model repo looked like at a particular branch, tag or commit?
      - Which files did a model have at an older Git revision?
      instructions:
      - text: Get model {repo_id} info at revision {revision}.
        slots:
          repo_id: path.repo_id
          revision: path.revision
      - text: Show {repo_id} as of commit or branch {revision}.
        slots:
          repo_id: path.repo_id
          revision: path.revision
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List evaluation metrics on the Hub
      effect: read
      questions:
      - Which evaluation metrics are available on the Hub?
      - Can I browse the metric names I can use to evaluate a model?
      instructions:
      - text: List the evaluation metrics on the Hub.
      - text: Show me every available Hub evaluation metric.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models-tags-by-type'].get
  update:
    x-apievangelist-phrasing:
      intent: List model tags grouped by type
      effect: read
      questions:
      - What pipeline tags, libraries, languages and licenses can models be tagged with?
      - Which tag values are valid when filtering model searches?
      instructions:
      - text: List all model tags grouped by type.
      - text: Show me the model license and library tags I can filter on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models'].get
  update:
    x-apievangelist-phrasing:
      intent: List models offered by inference providers
      effect: read
      questions:
      - Which models can I call through Hugging Face inference providers right now?
      - Can I get the model IDs the router accepts for inference requests?
      instructions:
      - text: List the models available through inference providers.
      - text: Show me which model IDs I can send to the inference router.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models/{model_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inference provider model's info
      effect: read
      questions:
      - Is a particular model available for inference through the providers router?
      - What basic metadata does the router report for a model I want to call?
      instructions:
      - text: Get inference availability info for model {model_id}.
        slots:
          model_id: path.model_id
      - text: Check whether {model_id} can be called through inference providers.
        slots:
          model_id: path.model_id
      method: generated
      generated: '2026-10-01'