Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pyagentspec/source/agentspec/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ with all the latest updates at :ref:`this link<agentspecspec_nightly>`.
Introduction, motivation & vision <intro_and_motivation>
Language specification (v25.4.1) <language_spec_25_4_1>
Positioning in the agentic ecosystem <positioning>
Tracing <tracing>
Original file line number Diff line number Diff line change
Expand Up @@ -3669,6 +3669,18 @@
"$ref": "#/$defs/OpenAIAPIType",
"default": "chat_completions"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Key"
},
"$referenced_components": {
"$ref": "#/$defs/ReferencedComponents"
},
Expand Down
6 changes: 5 additions & 1 deletion docs/pyagentspec/source/agentspec/language_spec_nightly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -649,13 +649,15 @@ OpenAI
This class of LLMs refers to the models offered by `OpenAI <https://openai.com>`_.
Similar to :ref:`OpenAI Compatible LLMs <openaicompatiblellms>`, you can also configure the ``api_type`` parameter,
which takes one of 2 string values, namely ``chat_completions`` or ``responses``.
By default, the API type is set to chat completions.
By default, the API type is set to chat completions. Additionally, an optional
``api_key`` can be set for the remote LLM model.

.. code-block:: python

class OpenAiConfig(LlmConfig):
model_id: str
api_type: Literal["chat_completions", "responses"] = "chat_completions"
api_key: SensitiveField[Optional[str]] = None

OCI GenAI
^^^^^^^^^
Expand Down Expand Up @@ -2365,6 +2367,8 @@ See all the fields below that are considered sensitive fields:
+==================================+====================+
| OpenAiCompatibleConfig | api_key |
+----------------------------------+--------------------+
| OpenAiConfig | api_key |
+----------------------------------+--------------------+
| OciClientConfigWithSecurityToken | auth_file_location |
+----------------------------------+--------------------+
| OciClientConfigWithApiKey | auth_file_location |
Expand Down
Loading