flexo/mkdocs.yml at main · IBM/flexo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
site_name: Flexo
site_url: https://pages.github.com/ibm/flexo
theme:
  name: material
  palette:
    scheme: slate
    primary: blue
    accent: pink
    toggle:
      icon: material/weather-night
      name: Switch to dark mode

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Deployment:
    - Overview: deployment/overview.md
    - Building Images: deployment/building-image.md
    - Platforms:
      - Overview: deployment/platforms/overview.md
      - Code Engine: deployment/platforms/code-engine.md
      - Fargate: deployment/platforms/fargate.md
      - Kubernetes: deployment/platforms/kubernetes.md
      - OpenShift: deployment/platforms/openshift.md
    - Registries:
      - Overview: deployment/registries/overview.md
      - DockerHub: deployment/registries/dockerhub.md
      - IBM Registry: deployment/registries/ibm-registry.md
  - Agent Configuration: agent-configuration.md
  - Model Configuration: model-configuration.md
  - REST API: api.md
  - Code Reference:
    - Overview: reference/index.md
    - Agent:
      - Overview: reference/agent/index.md
      - Streaming Chat Agent: reference/agent/chat_agent_streaming.md
    - API:
      - Overview: reference/api/index.md
      - SSE Models: reference/api/sse_models.md
      - Request Models: reference/api/request_models.md
    - Data Models:
      - Overview: reference/data_models/index.md
      - Agent Models: reference/data_models/agent.md
      - Chat Completion Models: reference/data_models/chat_completions.md
      - Streaming Models: reference/data_models/streaming.md
      - Tool Models: reference/data_models/tools.md
      - WX Assistant Models: reference/data_models/wx_assistant.md
    - Database:
      - Overview: reference/database/index.md
      - Base Adapter: reference/database/base_adapter.md
      - Elasticsearch Client: reference/database/elastic_client.md
      - Milvus Client: reference/database/milvus_client.md
      - Query Builder: reference/database/query_builder.md
    - LLM:
      - Overview: reference/llm/index.md
      - Factory: reference/llm/llm_factory.md
      - Adapters:
        - Overview: reference/llm/adapters/index.md
        - Base Adapter: reference/llm/adapters/base_vendor_adapter.md
        - Anthropic: reference/llm/adapters/anthropic_adapter.md
        - MistralAI: reference/llm/adapters/mistral_ai_adapter.md
        - OpenAI: reference/llm/adapters/openai_adapter.md
        - xAI: reference/llm/adapters/xai_adapter.md
        - WatsonX:
          - Overview: reference/llm/adapters/watsonx/index.md
          - Adapter: reference/llm/adapters/watsonx/watsonx_adapter.md
          - Config: reference/llm/adapters/watsonx/watsonx_config.md
          - Token Manager: reference/llm/adapters/watsonx/ibm_token_manager.md
        - OpenAI-Compatible: reference/llm/adapters/openai_compat_adapter.md
      - Pattern Detection:
        - Overview: reference/llm/pattern_detection/index.md
        - Aho-Corasick: reference/llm/pattern_detection/aho_corasick.md
        - Aho-Corasick Normalized: reference/llm/pattern_detection/aho_corasick_normalized.md
        - Base Processor Class: reference/llm/pattern_detection/base_buffered_processor.md
        - Buffered Processor Normalized: reference/llm/pattern_detection/buffered_processor_normalized.md
        - Buffered Processor Standard: reference/llm/pattern_detection/buffered_processor_standard.md
        - Pattern Utils: reference/llm/pattern_detection/pattern_utils.md
      - Tool Detection:
        - Overview: reference/llm/tool_detection/index.md
        - Base Strategy: reference/llm/tool_detection/base_detection_strategy.md
        - Detection Result: reference/llm/tool_detection/detection_result.md
        - Manual Strategy: reference/llm/tool_detection/manual_detection_strategy.md
        - Vendor Strategy: reference/llm/tool_detection/vendor_detection_strategy.md
    - Prompt Builders:
      - Overview: reference/prompt_builders/index.md
      - Base Builder: reference/prompt_builders/base_prompt_builder.md
      - Models: reference/prompt_builders/prompt_models.md
      - Anthropic: reference/prompt_builders/anthropic_prompt_builder.md
      - MistralAI: reference/prompt_builders/mistral_ai_prompt_builder.md
      - OpenAI: reference/prompt_builders/openai_prompt_builder.md
      - xAI: reference/prompt_builders/xai_prompt_builder.md
      - WatsonX:
        - Overview: reference/prompt_builders/watsonx/index.md
        - Granite: reference/prompt_builders/watsonx/granite/granite_prompt_builder.md
        - Llama: reference/prompt_builders/watsonx/llama/llama_prompt_builder.md
        - Mistral: reference/prompt_builders/watsonx/mistral/mistral_prompt_builder.md
      - OpenAI Compatible:
          - Granite: reference/prompt_builders/openai_compat/granite_prompt_builder.md
          - Llama: reference/prompt_builders/openai_compat/llama_prompt_builder.md
    - Tools:
      - Overview: reference/tools/index.md
      - Base Tool: reference/tools/core/base_tool.md
      - Base REST Tool: reference/tools/core/base_rest_tool.md
      - Tool Registry: reference/tools/core/tool_registry.md
      - Core:
          - Parsers:
              - Overview: reference/tools/core/parsers/index.md
              - Base Parser: reference/tools/core/parsers/base_tool_call_parser.md
              - JSON Parser: reference/tools/core/parsers/json_tool_call_parser.md
              - Non-JSON Parser: reference/tools/core/parsers/non_json_tool_call_parser.md
          - Utils:
              - Overview: reference/tools/core/utils/index.md
              - Token Manager: reference/tools/core/utils/token_manager.md
              - Tool Builder: reference/tools/core/utils/tool_builder.md
              - Tool Discovery: reference/tools/core/utils/tool_discovery.md
      - Implementations:
        - Overview: reference/tools/implementations/index.md
        - RAG Tool: reference/tools/implementations/rag_tool.md
        - Weather Tool: reference/tools/implementations/weather_tool.md
        - DuckDuckGo Tool: reference/tools/implementations/duckduckgo_tool.md
    - Utils:
      - Overview: reference/utils/index.md
      - Factory: reference/utils/factory.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["."]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            docstring_style: google

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.details