{ "opencollection": "1.0.0", "info": { "name": "Generative AI Agents Client Generative AI Agent Runtime API", "version": "20240531" }, "items": [ { "info": { "name": "generativeAiAgentRuntime", "type": "folder" }, "items": [ { "info": { "name": "Chat with endpoint", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId/actions/chat", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "A unique ID for the endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Chat on endpoint with provided messages.\n" }, { "info": { "name": "Creates an agent Session.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId/sessions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "A unique ID for the endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A session represents an interactive conversation initiated by a user through an API to engage with an agent. It involves a series of exchanges where the user sends queries or prompts, and the agent responds with relevant information, actions, or assistance based on the user's input. The session persists for the duration of the interaction, maintaining context and continuity to provide coherent and meaningful responses throughout the conversation.Creates an agent session.\n\nUse this API to create" }, { "info": { "name": "Return the session resource identified by the session ID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId/sessions/:sessionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "A unique ID for the endpoint." }, { "name": "sessionId", "value": "", "type": "path", "description": "A unique ID for the session." } ] }, "docs": "Return the session resource identified by the session ID.\n" }, { "info": { "name": "Update session metadata, including but not limited to description, tags.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId/sessions/:sessionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "A unique ID for the endpoint." }, { "name": "sessionId", "value": "", "type": "path", "description": "A unique ID for the session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update session metadata, including but not limited to description, tags.\n" }, { "info": { "name": "Delete a session and all associated information.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240531/agentEndpoints/:agentEndpointId/sessions/:sessionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentEndpointId", "value": "", "type": "path", "description": "A unique ID for the endpoint." }, { "name": "sessionId", "value": "", "type": "path", "description": "A unique ID for the session." } ] }, "docs": "Delete a session and all its associated information.\n" }, { "info": { "name": "Retrieve Metadata of knowledge base", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240531/knowledgeBases/:knowledgeBaseId/actions/retrieveMetadata", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "A unique ID for the Knowledge Base." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns metadata of provided knowledgeBase. Return available metadata with information of field names, their types, supported operations, and possible values.\n" } ] } ], "bundled": true }