|
<< Click to Display Table of Contents >> Navigation: 3. Script Language > AI - Artificial Intelligence Commands > AIU. - OpenAI API > !Model and Endpoint Configuration > AIU. - Artificial Intelligence Utility |
MiniRobotLanguage (MRL)
AIU.SetResponsesEndpoint
Set the Responses Endpoint URL for AIU Operations
Intention
SetResponsesEndpoint Command: Configuring the Responses API Endpoint
The SetResponsesEndpoint command allows you to specify a custom URL endpoint for retrieving responses in the AIU system, such as those generated by AIU.GenerateResponses or similar operations.
This provides flexibility to integrate with alternative OpenAI-compatible services or proxies for response generation.
It’s part of the AIU - OpenAI API suite.
This command sets the URL endpoint that the AIU system uses to fetch responses from an API, overriding the default OpenAI responses endpoint (e.g., https://api.openai.com/v1/responses).
It enables redirection to a custom server or service that supports OpenAI’s response API structure.
Customizing the responses endpoint is useful for:
•Service Integration: Connect to alternative AI services or self-hosted APIs.
•Proxy Usage: Route response requests through a proxy for security or logging.
•Testing: Direct requests to a development endpoint during script testing.
The command requires one parameter: the full URL of the responses endpoint.
Once set, subsequent response-related operations will use this endpoint until changed or reset via Init_AIU().
Example Usage
AIU.SetResponsesEndpoint|https://myproxy.example.com/v1/responses
AIU.GetResponsesEndpoint|$$URL
DBP.Responses Endpoint: $$URL
This sets the responses endpoint to a custom proxy and verifies it with AIU.GetResponsesEndpoint.
Illustration
┌────────────────────────────┐
│ Responses Endpoint │
├────────────────────────────┤
│ https://myproxy.example.com│
└────────────────────────────┘
The configured responses endpoint URL for AIU operations.
Syntax
AIU.SetResponsesEndpoint|P1
AIU.Set_ResponsesEndpoint|P1
Parameter Explanation
P1 - (Required) The full URL of the responses endpoint (e.g., https://api.openai.com/v1/responses or a custom URL).
Example
AIU.SetResponsesEndpoint|https://local-ai-server:8080/v1/responses
AIU.GetResponsesEndpoint|$$RES
DBP.Responses Endpoint: $$RES
ENR.
Remarks
- The endpoint must support OpenAI’s response API structure for compatibility.
- Changes persist until a new endpoint is set or the AIU system is reinitialized.
Limitations
- No validation of the URL’s accessibility or correctness is performed at setting time.
- Exactly one parameter is required; deviations cause an error.
See also: