From b35b546a2e120f78e77c42711becf7094d7bc3b3 Mon Sep 17 00:00:00 2001 From: Alexey Rybak Date: Thu, 2 Oct 2025 13:50:47 -0700 Subject: [PATCH] docs: provider formatting updates --- docs/docs/providers/agents/index.mdx | 4 ++-- docs/docs/providers/batches/index.mdx | 24 ++++++++++++------------ docs/docs/providers/files/index.mdx | 7 +++++++ docs/docs/providers/inference/index.mdx | 20 ++++++++++++-------- docs/docs/providers/safety/index.mdx | 7 +++++++ 5 files changed, 40 insertions(+), 22 deletions(-) diff --git a/docs/docs/providers/agents/index.mdx b/docs/docs/providers/agents/index.mdx index 52b92734e..06eb104af 100644 --- a/docs/docs/providers/agents/index.mdx +++ b/docs/docs/providers/agents/index.mdx @@ -1,7 +1,7 @@ --- description: "Agents -APIs for creating and interacting with agentic systems." + APIs for creating and interacting with agentic systems." sidebar_label: Agents title: Agents --- @@ -12,6 +12,6 @@ title: Agents Agents -APIs for creating and interacting with agentic systems. + APIs for creating and interacting with agentic systems. This section contains documentation for all available providers for the **agents** API. diff --git a/docs/docs/providers/batches/index.mdx b/docs/docs/providers/batches/index.mdx index 18e5e314d..2c64b277f 100644 --- a/docs/docs/providers/batches/index.mdx +++ b/docs/docs/providers/batches/index.mdx @@ -1,14 +1,14 @@ --- description: "The Batches API enables efficient processing of multiple requests in a single operation, -particularly useful for processing large datasets, batch evaluation workflows, and -cost-effective inference at scale. + particularly useful for processing large datasets, batch evaluation workflows, and + cost-effective inference at scale. -The API is designed to allow use of openai client libraries for seamless integration. + The API is designed to allow use of openai client libraries for seamless integration. -This API provides the following extensions: - - idempotent batch creation + This API provides the following extensions: + - idempotent batch creation -Note: This API is currently under active development and may undergo changes." + Note: This API is currently under active development and may undergo changes." sidebar_label: Batches title: Batches --- @@ -18,14 +18,14 @@ title: Batches ## Overview The Batches API enables efficient processing of multiple requests in a single operation, -particularly useful for processing large datasets, batch evaluation workflows, and -cost-effective inference at scale. + particularly useful for processing large datasets, batch evaluation workflows, and + cost-effective inference at scale. -The API is designed to allow use of openai client libraries for seamless integration. + The API is designed to allow use of openai client libraries for seamless integration. -This API provides the following extensions: - - idempotent batch creation + This API provides the following extensions: + - idempotent batch creation -Note: This API is currently under active development and may undergo changes. + Note: This API is currently under active development and may undergo changes. This section contains documentation for all available providers for the **batches** API. diff --git a/docs/docs/providers/files/index.mdx b/docs/docs/providers/files/index.mdx index 7d729d90f..19e338035 100644 --- a/docs/docs/providers/files/index.mdx +++ b/docs/docs/providers/files/index.mdx @@ -1,4 +1,7 @@ --- +description: "Files + + This API is used to upload documents that can be used with other Llama Stack APIs." sidebar_label: Files title: Files --- @@ -7,4 +10,8 @@ title: Files ## Overview +Files + + This API is used to upload documents that can be used with other Llama Stack APIs. + This section contains documentation for all available providers for the **files** API. diff --git a/docs/docs/providers/inference/index.mdx b/docs/docs/providers/inference/index.mdx index 1dc479675..c2bf69962 100644 --- a/docs/docs/providers/inference/index.mdx +++ b/docs/docs/providers/inference/index.mdx @@ -1,9 +1,11 @@ --- -description: "Llama Stack Inference API for generating completions, chat completions, and embeddings. +description: "Inference -This API provides the raw interface to the underlying models. Two kinds of models are supported: -- LLM models: these models generate \"raw\" and \"chat\" (conversational) completions. -- Embedding models: these models generate embeddings to be used for semantic search." + Llama Stack Inference API for generating completions, chat completions, and embeddings. + + This API provides the raw interface to the underlying models. Two kinds of models are supported: + - LLM models: these models generate \"raw\" and \"chat\" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search." sidebar_label: Inference title: Inference --- @@ -12,10 +14,12 @@ title: Inference ## Overview -Llama Stack Inference API for generating completions, chat completions, and embeddings. +Inference -This API provides the raw interface to the underlying models. Two kinds of models are supported: -- LLM models: these models generate "raw" and "chat" (conversational) completions. -- Embedding models: these models generate embeddings to be used for semantic search. + Llama Stack Inference API for generating completions, chat completions, and embeddings. + + This API provides the raw interface to the underlying models. Two kinds of models are supported: + - LLM models: these models generate "raw" and "chat" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search. This section contains documentation for all available providers for the **inference** API. diff --git a/docs/docs/providers/safety/index.mdx b/docs/docs/providers/safety/index.mdx index 3445b17e6..4e2de4f33 100644 --- a/docs/docs/providers/safety/index.mdx +++ b/docs/docs/providers/safety/index.mdx @@ -1,4 +1,7 @@ --- +description: "Safety + + OpenAI-compatible Moderations API." sidebar_label: Safety title: Safety --- @@ -7,4 +10,8 @@ title: Safety ## Overview +Safety + + OpenAI-compatible Moderations API. + This section contains documentation for all available providers for the **safety** API.