openapi: 3.2.0 info: description: 'OCI Generative AI Agents is a fully managed service that combines the power of large language models (LLMs) with an intelligent retrieval system to create contextually relevant answers by searching your knowledge base, making your AI applications smart and efficient. OCI Generative AI Agents supports several ways to onboard your data and then allows you and your customers to interact with your data using a chat interface or API. Use the Generative AI Agents API to create and manage agents, knowledge bases, data sources, endpoints, data ingestion jobs, and work requests. For creating and managing client chat sessions see the [Generative AI Agents Client API](#/EN/generative-ai-agents-client/latest/). To learn more about the service, see the [Generative AI Agents documentation](/iaas/Content/generative-ai-agents/home.htm). ' title: Generative AI Agents Management Generative AI Agent API version: '20240531' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/1d2dbd50a3be3ff88d4f56b9844039efda090715c309f0acb6b75b1107aa0c4d.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Generative AI Agents Management API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/1d2dbd50a3be3ff88d4f56b9844039efda090715c309f0acb6b75b1107aa0c4d.yaml what: the harvested document for Generative AI Agents Management API servers: - url: http://127.0.0.1/20240531 - url: https://127.0.0.1/20240531 tags: - name: generativeAiAgent paths: /agentEndpoints: get: description: 'Gets a list of endpoints. ' operationId: ListAgentEndpoints parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AgentIdentifierQueryParam' - $ref: '#/components/parameters/AgentEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of AgentEndpointSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AgentEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of endpoints. tags: - generativeAiAgent x-related-resource: '#/definitions/AgentEndpoint' post: description: 'Creates an endpoint. ' operationId: CreateAgentEndpoint parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The endpoint will be created. headers: content-location: description: The location for the content. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: The URL for the created endpoint. The endpoint OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AgentEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates an endpoint. tags: - generativeAiAgent x-example: "\nPOST /20240531/agentEndpoints\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"agentendpoint display name\",\n \"description\": \"agentendpoint description\",\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"agentId\": \"ocid1.genaiagent.oc1.us-chicago-1.xxxx\",\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"shouldEnableCitation\" : false,\n \"shouldEnableTrace\" : false,\n \"shouldEnableMultiLanguage\": false,\n \"contentModerationConfig\" : false,\n \"shouldEnableSession\": true,\n \"sessionConfig\" : {\n \"idleTimeoutInSeconds\" : 3600\n }\n}\n" x-related-resource: '#/definitions/AgentEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentEndpointDetails' description: Details for the new endpoint. required: true /agentEndpoints/{agentEndpointId}: delete: description: 'Deletes an endpoint. ' operationId: DeleteAgentEndpoint parameters: - $ref: '#/components/parameters/AgentEndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The AgentEndpoint will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an AgentEndpoint. tags: - generativeAiAgent x-example: ' DELETE /20240531/agentEndpoints/ Host: agent.generativeai.{region}.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AgentEndpoint' get: description: 'Gets information about an endpoint. ' operationId: GetAgentEndpoint parameters: - $ref: '#/components/parameters/AgentEndpointIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The endpoint was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AgentEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get AgentEndpoint tags: - generativeAiAgent put: description: 'Updates an endpoint. ' operationId: UpdateAgentEndpoint parameters: - $ref: '#/components/parameters/AgentEndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The endpoint will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates an AgentEndpoint. tags: - generativeAiAgent x-example: "\nPUT /20240531/agentEndpoints/\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"agentendpoint display name\",\n \"description\": \"agentendpoint description\",\n \"sessionConfig\": {\n \"idleTimeoutInSeconds\": 8900\n }\n}\n" x-related-resource: '#/definitions/AgentEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAgentEndpointDetails' description: The information to be updated. required: true /agentEndpoints/{agentEndpointId}/actions/changeCompartment: post: description: 'Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeAgentEndpointCompartment parameters: - $ref: '#/components/parameters/AgentEndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The AgentEndpoint will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves an AgentEndpoint into a different compartment. tags: - generativeAiAgent x-example: "\nPOST /20240531/agentEndpoints//actions/changeCompartment\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\"\n}\n" x-related-resource: '#/definitions/AgentEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAgentEndpointCompartmentDetails' description: The information to be updated. required: true /agents: get: description: 'Gets a list of agents. ' operationId: ListAgents parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AgentLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of AgentSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AgentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of Agents. tags: - generativeAiAgent x-related-resource: '#/definitions/Agent' post: description: 'Creates an agent. ' operationId: CreateAgent parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The agent will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created agent. The agent OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Agent' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates an Agent. tags: - generativeAiAgent x-example: "\nPOST /20240531/agents\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"dummy-agent-name\",\n \"description\": \"dummy agent description\",\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"freeformTags\": {\n \"additionalProp1\": \"dummy prop1\",\n \"additionalProp2\": \"dummy prop2\",\n \"additionalProp3\": \"dummy prop3\"\n },\n \"knowledgeBaseIds\": [\n \"ocid1.genaiagentknowledgebase.oc1.us-chicago-1.xxxx\"\n ],\n \"welcomeMessage\": \"dummy welcome message\",\n \"definedTags\": {\n \"additionalProp1\": \"dummy\",\n \"additionalProp2\": \"dummy\",\n \"additionalProp3\": \"dummy\"\n }\n}\n" x-related-resource: '#/definitions/Agent' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentDetails' description: Details for the new agent. required: true /agents/{agentId}: delete: description: 'Deletes an agent. ' operationId: DeleteAgent parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The agent will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an Agent. tags: - generativeAiAgent x-example: ' DELETE /20240531/agents/ Host: agent.generativeai.{region}.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Agent' get: description: 'Gets information about an agent. ' operationId: GetAgent parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The agent was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Agent' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Agent tags: - generativeAiAgent put: description: 'Updates an agent. ' operationId: UpdateAgent parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The agent will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates an Agent. tags: - generativeAiAgent x-example: "\nPUT /20240531/agents/\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"agent-display-name-update\",\n \"description\": \"agent-description-name-update\",\n \"knowledgeBases\": [\n \"ocid1.genaiagentknowledgebase.oc1.us-chicago-1.xxxx\"\n ]\n}\n" x-related-resource: '#/definitions/Agent' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAgentDetails' description: The information to be updated. required: true /agents/{agentId}/actions/changeCompartment: post: description: 'Moves an agent into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeAgentCompartment parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The agent will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves an agent into a different compartment. tags: - generativeAiAgent x-example: "\nPOST /20240531/agents//actions/changeCompartment\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\"\n}\n" x-related-resource: '#/definitions/Agent' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAgentCompartmentDetails' description: The information to be updated. required: true /dataIngestionJobs: get: description: 'Gets a list of data ingestion jobs. ' operationId: ListDataIngestionJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DataSourceIdentifierQueryParam' - $ref: '#/components/parameters/DataIngestionJobLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DataIngestionJobSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataIngestionJobCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of data ingestion jobs. tags: - generativeAiAgent x-related-resource: '#/definitions/DataIngestionJob' post: description: 'Creates a data ingestion job. ' operationId: CreateDataIngestionJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The data ingestion job will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: The URL for the created data ingestion job. The data ingestion job OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataIngestionJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a data ingestion job. tags: - generativeAiAgent x-example: "\nPOST /20240531/dataIngestionJobs\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"dataIngestionJob display name\",\n \"description\": \"dataIngestionJob description\",\n \"dataSourceId\": \"ocid1.genaiagentdatasource.oc1.us-chicago-1.xxxx\",\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n" x-related-resource: '#/definitions/DataIngestionJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataIngestionJobDetails' description: Details for the new data ingestion job. required: true /dataIngestionJobs/{dataIngestionJobId}: delete: description: 'Deletes a data ingestion job. ' operationId: DeleteDataIngestionJob parameters: - $ref: '#/components/parameters/DataIngestionJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The data ingestion job will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a data ingestion job. tags: - generativeAiAgent x-example: ' DELETE /20240531/dataIngestionJobs/ Host: agent.generativeai.{region}.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DataIngestionJob' get: description: 'Gets information about a data ingestion job. ' operationId: GetDataIngestionJob parameters: - $ref: '#/components/parameters/DataIngestionJobIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The data ingestion job was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataIngestionJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get DataIngestionJob tags: - generativeAiAgent /dataIngestionJobs/{dataIngestionJobId}/logs/content: get: description: 'Returns the raw log file for the specified data ingestion job in text format. ' operationId: GetDataIngestionJobLogContent parameters: - $ref: '#/components/parameters/DataIngestionJobIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The data ingestion job Logs were retrieved. headers: opc-request-id: description: Unique identifier for the request schema: type: string content: text/plain; charset=utf-8: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the raw logs for a Data Ingestion job. tags: - generativeAiAgent x-related-resource: '#/definitions/DataIngestionJob' /dataSources: get: description: 'Gets a list of data sources. ' operationId: ListDataSources parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/KnowledgeBaseIdentifierQueryParam' - $ref: '#/components/parameters/DataSourceLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DataSourceSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of data sources. tags: - generativeAiAgent x-related-resource: '#/definitions/DataSource' post: description: 'Creates a data source. ' operationId: CreateDataSource parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The data source will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created data source. The data source OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSource' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a DataSource. tags: - generativeAiAgent x-example: "\nPOST /20240531/dataSources\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"datasource display name\",\n \"description\": \"datasource description\",\n \"knowledgeBaseId\": \"ocid1.genaiagentknowledgebase.oc1.us-chicago-1.xxxx\",\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"dataSourceConfig\": {\n \"dataSourceConfigType\": \"OCI_OBJECT_STORAGE\",\n \"objectStoragePrefixes\": [\n {\n \"bucketName\": \"bucketName\",\n \"objectName\": \"objectName\",\n \"namespaceName\": \"namespaceName\"\n }\n ]\n },\n \"chunkingConfig\": {\n \"chunkingConfigType\": \"NONE\"\n },\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n" x-related-resource: '#/definitions/DataSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataSourceDetails' description: Details for the new data source. required: true /dataSources/{dataSourceId}: delete: description: 'Deletes a data source. ' operationId: DeleteDataSource parameters: - $ref: '#/components/parameters/DataSourceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The data source will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a DataSource. tags: - generativeAiAgent x-example: ' DELETE /20240531/dataSources/ Host: agent.generativeai.{region}.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DataSource' get: description: 'Gets information about a data source. ' operationId: GetDataSource parameters: - $ref: '#/components/parameters/DataSourceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The data source was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSource' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get DataSource tags: - generativeAiAgent put: description: 'Updates a data source. ' operationId: UpdateDataSource parameters: - $ref: '#/components/parameters/DataSourceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The data source will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a data source. tags: - generativeAiAgent x-example: "\nPUT /20240531/dataSources/\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"dataSource display name\",\n \"description\": \"dataSource description\"\n}\n" x-related-resource: '#/definitions/DataSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataSourceDetails' description: The data source information to be updated. required: true /knowledgeBases: get: description: 'Gets a list of knowledge bases. ' operationId: ListKnowledgeBases parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/KnowledgeBaseLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of KnowledgeBaseSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KnowledgeBaseCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of knowledge bases. tags: - generativeAiAgent x-related-resource: '#/definitions/KnowledgeBase' post: description: 'Creates a knowledge base. ' operationId: CreateKnowledgeBase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The knowledge base will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created knowledge base. The knowledge base OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KnowledgeBase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a KnowledgeBase. tags: - generativeAiAgent x-example: "\nSample 1: Create Knowledge base with opensearch index\n\nPOST /20240531/knowledgeBases\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"knowledgeBase display name\",\n \"description\": \"knowledgeBase description\",\n \"indexConfig\": {\n \"indexConfigType\": \"OCI_OPEN_SEARCH_INDEX_CONFIG\",\n \"clusterId\": \"{{clusterId}}\",\n \"secretDetail\" : {\n \"type\": \"BASIC_AUTH_SECRET\",\n \"vaultSecretId\": \"{{vaultSecretId}}\"\n },\n \"indexes\": [\n {\n \"name\": \"sample-index\",\n \"schema\": {\n \"bodyKey\": \"body\",\n \"urlKey\": \"url\",\n \"titleKey\": \"title\",\n \"embeddingBodyKey\": \"body_embedding\"\n }\n }\n ]\n },\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n\nSample 2: Create Knowledge base with default index\n\nPOST /20240531/knowledgeBases\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"knowledgeBase display name\",\n \"description\": \"knowledgeBase description\",\n \"indexConfig\": {\n \"indexConfigType\": \"DEFAULT_INDEX_CONFIG\"\n },\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n" x-related-resource: '#/definitions/KnowledgeBase' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKnowledgeBaseDetails' description: Details for the new knowledge base. required: true /knowledgeBases/{knowledgeBaseId}: delete: description: 'Deletes a knowledge base. ' operationId: DeleteKnowledgeBase parameters: - $ref: '#/components/parameters/KnowledgeBaseIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The knowledge base will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a KnowledgeBase. tags: - generativeAiAgent x-example: ' DELETE /20240531/knowledgeBases/ Host: agent.generativeai.{region}.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/KnowledgeBase' get: description: 'Gets information about a knowledge base. ' operationId: GetKnowledgeBase parameters: - $ref: '#/components/parameters/KnowledgeBaseIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The knowledge base was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KnowledgeBase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get KnowledgeBase tags: - generativeAiAgent put: description: 'Updates a knowledge base. ' operationId: UpdateKnowledgeBase parameters: - $ref: '#/components/parameters/KnowledgeBaseIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The knowledge base will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a knowledge base. tags: - generativeAiAgent x-example: "\nPUT /20240531/knowledgeBases/\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"knowledgeBase display name\",\n \"description\": \"update knowledgeBase description\",\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n" x-related-resource: '#/definitions/KnowledgeBase' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateKnowledgeBaseDetails' description: The information to be updated. required: true /knowledgeBases/{knowledgeBaseId}/actions/changeCompartment: post: description: 'Moves a knowledge base into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeKnowledgeBaseCompartment parameters: - $ref: '#/components/parameters/KnowledgeBaseIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The knowledge base will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a KnowledgeBase into a different compartment. tags: - generativeAiAgent x-example: "\nPOST /20240531/knowledgeBases//actions/changeCompartment\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\"\n}\n" x-related-resource: '#/definitions/KnowledgeBase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeKnowledgeBaseCompartmentDetails' description: The information to be updated. required: true /provisionedCapacities: get: description: 'Gets a list of provisioned capacities. ' operationId: ListProvisionedCapacities parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProvisionedCapacityIdentifierQueryParam' - $ref: '#/components/parameters/ProvisionedCapacityLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ProvisionedCapacitySummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProvisionedCapacityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of provisioned capacities. tags: - generativeAiAgent x-related-resource: '#/definitions/ProvisionedCapacity' post: description: 'Creates a provisioned capacity. ' operationId: CreateProvisionedCapacity parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The provisioned capacity will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created provisioned capacity. The provisioned capacity OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProvisionedCapacity' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a ProvisionedCapacity. tags: - generativeAiAgent x-example: "\nPOST /20240531/provisionedCapacities\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"provisionedCapacity display name\",\n \"numOfUnits\": 100,\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n" x-related-resource: '#/definitions/ProvisionedCapacity' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProvisionedCapacityDetails' description: Details for the new provisioned capacity. required: true /provisionedCapacities/{provisionedCapacityId}: delete: description: 'Deletes a provisioned capacity. ' operationId: DeleteProvisionedCapacity parameters: - $ref: '#/components/parameters/ProvisionedCapacityIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The provisioned capacity will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a ProvisionedCapacity. tags: - generativeAiAgent x-example: ' DELETE /20240531/provisionedCapacities/ Host: agent.generativeai.{region}.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ProvisionedCapacity' get: description: 'Gets information about a provisioned capacity. ' operationId: GetProvisionedCapacity parameters: - $ref: '#/components/parameters/ProvisionedCapacityIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The provisioned capacity was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProvisionedCapacity' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get ProvisionedCapacity tags: - generativeAiAgent put: description: 'Updates a provisioned capacity. ' operationId: UpdateProvisionedCapacity parameters: - $ref: '#/components/parameters/ProvisionedCapacityIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The provisioned capacity will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a provisioned capacity. tags: - generativeAiAgent x-example: "\nPUT /20240531/provisionedCapacities/\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"provisionedCapacity display name\",\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\",\n \"numOfUnits\": 100,\n \"freeformTags\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n" x-related-resource: '#/definitions/ProvisionedCapacity' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProvisionedCapacityDetails' description: The information to be updated. required: true /provisionedCapacities/{provisionedCapacityId}/actions/changeCompartment: post: description: 'Moves a provisioned capacity into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeProvisionedCapacityCompartment parameters: - $ref: '#/components/parameters/ProvisionedCapacityIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The provisioned capacity will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a ProvisionedCapacity into a different compartment. tags: - generativeAiAgent x-example: "\nPOST /20240531/provisionedCapacities//actions/changeCompartment\nHost: agent.generativeai.{region}.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..xxxx\"\n}\n" x-related-resource: '#/definitions/ProvisionedCapacity' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProvisionedCapacityCompartmentDetails' description: The information to be updated. required: true /tools: get: description: 'Gets a list of tools. ' operationId: ListTools parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ToolLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/AgentIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of AgentSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ToolCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of Tools. tags: - generativeAiAgent x-related-resource: '#/definitions/Tool' post: description: 'Creates a tool. ' operationId: CreateTool parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The tool will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created tool. The tool OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Tool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a Tool. tags: - generativeAiAgent x-related-resource: '#/definitions/Tool' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateToolDetails' description: Details for the new tool. required: true /tools/{toolId}: delete: description: 'Deletes a tool. ' operationId: DeleteTool parameters: - $ref: '#/components/parameters/ToolIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The tool will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a Tool. tags: - generativeAiAgent x-related-resource: '#/definitions/Tool' get: description: 'Gets information about a tool. ' operationId: GetTool parameters: - $ref: '#/components/parameters/ToolIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The tool was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Tool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Tool tags: - generativeAiAgent put: description: 'Updates a tool. ' operationId: UpdateTool parameters: - $ref: '#/components/parameters/ToolIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The tool will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a Tool. tags: - generativeAiAgent x-related-resource: '#/definitions/Tool' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateToolDetails' description: The information to be updated. required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work requests was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work requests tags: - generativeAiAgent x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: 'Cancels a work request. ' operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel work request tags: - generativeAiAgent x-example: ' DELETE /20240531/workRequests/ Host: agent.generativeai.{region}.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' get: description: 'Gets the details of a work request. ' operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The work request was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get work request status tags: - generativeAiAgent x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Lists the errors for a work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request errors was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request errors tags: - generativeAiAgent x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Lists the logs for a work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request logs. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request logs tags: - generativeAiAgent x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: PlatformRuntimeConfig: description: Configuration for agent platform component. properties: platformRuntimeConfigType: default: AGENT_PLATFORM description: 'The type of Platform runtime config. ' enum: - AGENT_PLATFORM - FUSION_REASONING type: string version: description: The version of the Core. The latest version will be displayed as default. type: string type: object DataIngestionJobSummary: description: 'Summary information about a data ingestion job. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string dataIngestionJobStatistics: $ref: '#/components/schemas/DataIngestionJobStatistics' dataIngestionJobType: $ref: '#/components/schemas/DataIngestionJobType' dataSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent DataSource. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user-friendly description of the DataSource. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job. type: string lifecycleDetails: description: 'A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the data ingestion job. type: string x-obmcs-enumref: '#/definitions/DataIngestionJob/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the data ingestion job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the data ingestion job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - dataSourceId - lifecycleState - dataIngestionJobType - dataIngestionJobStatistics - timeCreated - displayName - freeformTags - definedTags type: object CreateAgentDetails: description: 'The data to create an agent. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the agent in. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description about the agent. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object knowledgeBaseIds: description: List of [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026. items: type: string type: array llmConfig: $ref: '#/components/schemas/LlmConfig' welcomeMessage: description: Details about purpose and responsibility of the agent maxLength: 255 type: string required: - compartmentId type: object Error: description: 'Error information ' properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error message. type: string required: - code - message PersonallyIdentifiableInformationGuardrailConfig: description: The configuration details for Personally Identifiable Information. properties: inputGuardrailMode: description: An input guardrail mode for personally identifiable information. enum: - DISABLE - BLOCK - INFORM type: string x-obmcs-top-level-enum: '#/definitions/GuardrailMode' outputGuardrailMode: description: An output guardrail mode for personally identifiable information. enum: - DISABLE - BLOCK - INFORM type: string x-obmcs-top-level-enum: '#/definitions/GuardrailMode' type: object AgentEndpoint: description: 'The endpoint to access a deployed agent. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: agentId: description: The OCID of the agent that this endpoint is associated with. type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string contentModerationConfig: $ref: '#/components/schemas/ContentModerationConfig' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the endpoint. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object guardrailConfig: $ref: '#/components/schemas/GuardrailConfig' humanInputConfig: $ref: '#/components/schemas/HumanInputConfig' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint. type: string lifecycleDetails: description: 'A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the endpoint. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object outputConfig: $ref: '#/components/schemas/OutputConfig' provisionedCapacityConfig: $ref: '#/components/schemas/ProvisionedCapacityConfig' sessionConfig: $ref: '#/components/schemas/SessionConfig' shouldEnableCitation: default: false description: Whether to show citations in the chat result. type: boolean shouldEnableMultiLanguage: default: false description: Whether to enable multi-language for chat. type: boolean shouldEnableSession: default: true description: Whether or not to enable Session-based chat. type: boolean shouldEnableTrace: default: false description: Whether to show traces in the chat result. type: boolean systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the AgentEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the endpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - agentId - timeCreated type: object DataIngestionJob: description: 'When you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent''s associated knowledge base, a process known as data ingestion. Data ingestion is a process that extracts data from data source documents, converts it into a structured format suitable for analysis, and then stores it in a knowledge base. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string dataIngestionJobStatistics: $ref: '#/components/schemas/DataIngestionJobStatistics' dataIngestionJobType: $ref: '#/components/schemas/DataIngestionJobType' dataSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent DataSource. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DataIngestionJob. type: string knowledgeBaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase. type: string lifecycleDetails: description: 'A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the data ingestion job. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - DELETING - DELETED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the data ingestion job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the data ingestion job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - dataSourceId - dataIngestionJobType - dataIngestionJobStatistics - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object UpdateAgentDetails: description: 'The data to update an agent. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description about the agent. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object knowledgeBaseIds: description: List of [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026. items: type: string type: array llmConfig: $ref: '#/components/schemas/LlmConfig' welcomeMessage: description: Details about purpose and responsibility of the agent maxLength: 255 type: string type: object WorkRequestSummaryCollection: description: 'A list of work requests. Can contain both work requests and other information, such as metadata. ' properties: items: description: A list of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object UpdateDataSourceDetails: description: 'The data to update a data source. ' properties: dataSourceConfig: $ref: '#/components/schemas/DataSourceConfig' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user-friendly description of the data source. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object type: object ProvisionedCapacityCollection: description: 'Results of a provisioned capacity search. Contains both ProvisionedCapacitySummary items. ' properties: items: description: List of provisioned capacities. items: $ref: '#/components/schemas/ProvisionedCapacitySummary' type: array required: - items type: object DataSourceCollection: description: 'Results of a dataSource search. Contains both DataSourceSummary items and other information, such as metadata. ' properties: items: description: List of data sources. items: $ref: '#/components/schemas/DataSourceSummary' type: array required: - items type: object CreateDataIngestionJobDetails: description: 'The data to create a data ingestion job. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the data ingestion job in. ' maxLength: 255 minLength: 1 type: string dataSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent DataSource. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user-friendly description of the data ingestion job. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId - dataSourceId type: object CreateKnowledgeBaseDetails: description: 'The data to create a knowledge base. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the knowledge base in. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user-friendly description of the knowledge base. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object indexConfig: $ref: '#/components/schemas/IndexConfig' required: - indexConfig - compartmentId type: object WorkRequestSummary: description: 'Summary information about an asynchronous work request. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_AGENT - UPDATE_AGENT - DELETE_AGENT - MOVE_AGENT - CREATE_AGENT_ENDPOINT - UPDATE_AGENT_ENDPOINT - DELETE_AGENT_ENDPOINT - MOVE_AGENT_ENDPOINT - CREATE_DATA_SOURCE - UPDATE_DATA_SOURCE - DELETE_DATA_SOURCE - CREATE_KNOWLEDGE_BASE - UPDATE_KNOWLEDGE_BASE - DELETE_KNOWLEDGE_BASE - MOVE_KNOWLEDGE_BASE - CREATE_DATA_INGESTION_JOB - DELETE_DATA_INGESTION_JOB - CREATE_TOOL - UPDATE_TOOL - DELETE_TOOL - CREATE_PROVISIONED_CAPACITY - UPDATE_PROVISIONED_CAPACITY - DELETE_PROVISIONED_CAPACITY - MOVE_PROVISIONED_CAPACITY - CREATE_FLOW - UPDATE_FLOW - DELETE_FLOW type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted IndexConfig: description: 'The index configuration of Knowledge bases. ' discriminator: propertyName: indexConfigType properties: indexConfigType: description: 'The type of index. ' enum: - DEFAULT_INDEX_CONFIG - OCI_OPEN_SEARCH_INDEX_CONFIG - OCI_DATABASE_CONFIG type: string required: - indexConfigType type: object AgentEndpointSummary: description: 'Summary information about an endpoint. ' properties: agentId: description: The OCID of the agent that this AgentEndpoint is associated with. type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string contentModerationConfig: $ref: '#/components/schemas/ContentModerationConfig' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the endpoint. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object guardrailConfig: $ref: '#/components/schemas/GuardrailConfig' humanInputConfig: $ref: '#/components/schemas/HumanInputConfig' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AgentEndpoint. type: string lifecycleDetails: description: 'A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the endpoint. type: string x-obmcs-enumref: '#/definitions/AgentEndpoint/lifecycleState' metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object outputConfig: $ref: '#/components/schemas/OutputConfig' provisionedCapacityConfig: $ref: '#/components/schemas/ProvisionedCapacityConfig' sessionConfig: $ref: '#/components/schemas/SessionConfig' shouldEnableCitation: default: false description: Whether to show citations in the chat result. type: boolean shouldEnableMultiLanguage: default: false description: Whether to enable multi-language for chat. type: boolean shouldEnableSession: default: true description: Whether or not to enable Session-based chat. type: boolean shouldEnableTrace: default: false description: Whether to show traces in the chat result. type: boolean systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the endpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the AgentEndpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - agentId - timeCreated type: object CreateToolDetails: description: 'The data to create a Tool. ' properties: agentId: description: The OCID of the agent that this Tool is attached to. type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description about the Tool. maxLength: 1024 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object toolConfig: $ref: '#/components/schemas/ToolConfig' required: - toolConfig - agentId - compartmentId - description type: object ChangeAgentCompartmentDetails: description: 'The configuration details for the move operation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the agent to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ProvisionedCapacitySummary: description: 'Summary information about a provisioned capacity. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the provisioned capacity. type: string displayName: description: The name of the provisioned capacity. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity. type: string lifecycleState: description: The current state of the provisioned capacity. type: string x-obmcs-enumref: '#/definitions/ProvisionedCapacity/lifecycleState' numberOfUnits: description: Provisioned Capacity Unit corresponds to the amount of characters processed per minute. type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the provisioned capacity was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the provisioned capacity was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - numberOfUnits - timeCreated type: object DataIngestionJobCollection: description: 'Results of a data ingestion job search. Contains both DataIngestionJobSummary items and other information, such as metadata. ' properties: items: description: List of data ingestion jobs. items: $ref: '#/components/schemas/DataIngestionJobSummary' type: array required: - items type: object UpdateKnowledgeBaseDetails: description: 'The data to update a knowledge base. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the knowledge base. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object indexConfig: $ref: '#/components/schemas/IndexConfig' type: object ToolCollection: description: 'Results of a Tool search. Contains both ToolSummary items and other information, such as metadata. ' properties: items: description: List of Tools. items: $ref: '#/components/schemas/ToolSummary' type: array required: - items type: object KnowledgeBaseStatistics: description: Statistics for Default Knowledge Base. properties: sizeInBytes: description: Knowledge Base size in bytes. format: int64 type: integer totalIngestedFiles: description: Total number of ingested files in Knowledge Base. format: int64 type: integer type: object KnowledgeBaseSummary: description: 'Summary information about a knowledge base. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user-friendly description of the knowledge base. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base. type: string lifecycleDetails: description: 'A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the knowledge base. type: string x-obmcs-enumref: '#/definitions/KnowledgeBase/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the knowledge base was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the knowledge base was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object ChangeKnowledgeBaseCompartmentDetails: description: 'The configuration details for the move operation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the KnowledgeBase to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ToolConfig: description: 'The configuration and type of Tool. ' discriminator: propertyName: toolConfigType properties: toolConfigType: description: 'The type of the Tool config. ' enum: - SQL_TOOL_CONFIG - RAG_TOOL_CONFIG - FUNCTION_CALLING_TOOL_CONFIG - HTTP_ENDPOINT_TOOL_CONFIG - AGENT_TOOL_CONFIG type: string required: - toolConfigType type: object LlmConfig: description: 'Configuration to Agent LLM. ' properties: routingLlmCustomization: $ref: '#/components/schemas/LlmCustomization' runtimeVersion: description: The runtimeVersion of the system prompt. type: string type: object ChangeProvisionedCapacityCompartmentDetails: description: 'The configuration details for the move operation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the ProvisionedCapacity to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateToolDetails: description: 'The data to update a Tool. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description about the Tool. maxLength: 1024 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object toolConfig: $ref: '#/components/schemas/ToolConfig' type: object UpdateProvisionedCapacityDetails: description: 'The data to update a provisioned capacity. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the provisioned capacity. maxLength: 255 type: string displayName: description: The name of the provisioned capacity. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object numberOfUnits: description: Provisioned Capacity Unit corresponds to the amount of characters processed per minute. type: integer type: object Tool: description: 'The description of Tool. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: agentId: description: The OCID of the agent that this Tool is attached to. type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the Tool. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Tool. type: string lifecycleState: description: The current state of the Tool. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the Tool was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the Tool was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string toolConfig: $ref: '#/components/schemas/ToolConfig' required: - id - lifecycleState - timeCreated - description - compartmentId - agentId - toolConfig type: object ProvisionedCapacity: description: "A provisioned capacity is a resource pool of Genrative AI DACs with properties like AgentRuntimeVersion, unit size, and a tool name to DAC ID mapping. \n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n" properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the provisioned capacity. type: string displayName: description: The name of the provisioned capacity. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity. type: string lifecycleState: description: The current state of the provisioned capacity. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string numberOfUnits: description: Provisioned Capacity Unit corresponds to the amount of characters processed per minute. type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the provisioned capacity was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the provisioned capacity was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - numberOfUnits - timeCreated type: object SessionConfig: description: 'Session Configuration on AgentEndpoint. ' properties: idleTimeoutInSeconds: default: 3600 description: The session will become inactive after this timeout. type: integer type: object OutputConfig: description: 'Configuration to store results generated by agent. ' properties: outputLocation: $ref: '#/components/schemas/OutputLocation' retentionPeriodInMinutes: default: 360 description: Retention duration of the output data. type: integer required: - outputLocation type: object WorkRequestLogEntry: description: 'A log message from performing an operation that is tracked by a work request. ' properties: message: description: A human-readable log message. type: string timestamp: description: 'The date and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - message - timestamp DataIngestionJobStatistics: description: 'The statistics of data ingestion job. ' properties: durationInSeconds: description: The duration of this ingestion job. type: integer numberOfFailedFiles: description: The number of files that have failed during the ingestion. type: integer numberOfIgnoredFiles: description: The number of files that have been ignored during the ingestion. type: integer numberOfIngestedFiles: description: The number of files that have been successfully ingested during the ingestion. type: integer type: object PromptInjectionGuardrailConfig: description: The configuration details for Prompt Injection. properties: inputGuardrailMode: description: An input guardrail mode for prompt injection. enum: - DISABLE - BLOCK - INFORM type: string x-obmcs-top-level-enum: '#/definitions/GuardrailMode' type: object WorkRequest: description: 'An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation''s progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_AGENT - UPDATE_AGENT - DELETE_AGENT - MOVE_AGENT - CREATE_AGENT_ENDPOINT - UPDATE_AGENT_ENDPOINT - DELETE_AGENT_ENDPOINT - MOVE_AGENT_ENDPOINT - CREATE_DATA_SOURCE - UPDATE_DATA_SOURCE - DELETE_DATA_SOURCE - CREATE_KNOWLEDGE_BASE - UPDATE_KNOWLEDGE_BASE - DELETE_KNOWLEDGE_BASE - MOVE_KNOWLEDGE_BASE - CREATE_DATA_INGESTION_JOB - DELETE_DATA_INGESTION_JOB - CREATE_TOOL - UPDATE_TOOL - DELETE_TOOL - CREATE_PROVISIONED_CAPACITY - UPDATE_PROVISIONED_CAPACITY - DELETE_PROVISIONED_CAPACITY - MOVE_PROVISIONED_CAPACITY - CREATE_FLOW - UPDATE_FLOW - DELETE_FLOW type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted KnowledgeBase: description: 'A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the knowledge base. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base. type: string indexConfig: $ref: '#/components/schemas/IndexConfig' knowledgeBaseStatistics: $ref: '#/components/schemas/KnowledgeBaseStatistics' lifecycleDetails: description: 'A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the knowledge base. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the knowledge base was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the knowledge base was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - indexConfig - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object AgentEndpointCollection: description: 'Results of an agentEndpoint search. Contains both AgentEndpointSummary items and other information, such as metadata. ' properties: items: description: List of endpoints. items: $ref: '#/components/schemas/AgentEndpointSummary' type: array required: - items type: object DataSourceSummary: description: 'Summary information about a data source. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the data source. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source. type: string knowledgeBaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase. type: string lifecycleDetails: description: 'A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the data source. type: string x-obmcs-enumref: '#/definitions/DataSource/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the data source was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the DataSource was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - knowledgeBaseId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object OutputLocation: description: 'Location of the output. ' discriminator: propertyName: outputLocationType properties: outputLocationType: default: OBJECT_STORAGE_PREFIX description: Type of OutputLocation. enum: - OBJECT_STORAGE_PREFIX type: string required: - outputLocationType type: object LlmSelection: description: 'LLM selection configuration - either DEFAULT or CUSTOM. ' discriminator: propertyName: llmSelectionType properties: llmSelectionType: description: Type of LLM selection enum: - DEFAULT - CUSTOM_GEN_AI_MODEL - CUSTOM_GEN_AI_ENDPOINT type: string required: - llmSelectionType type: object CreateAgentEndpointDetails: description: 'The data to create an endpoint. ' properties: agentId: description: The OCID of the agent that this endpoint is associated with. type: string compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the endpoint in. ' maxLength: 255 minLength: 1 type: string contentModerationConfig: $ref: '#/components/schemas/ContentModerationConfig' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the endpoint. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object guardrailConfig: $ref: '#/components/schemas/GuardrailConfig' humanInputConfig: $ref: '#/components/schemas/HumanInputConfig' metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object outputConfig: $ref: '#/components/schemas/OutputConfig' provisionedCapacityConfig: $ref: '#/components/schemas/ProvisionedCapacityConfig' sessionConfig: $ref: '#/components/schemas/SessionConfig' shouldEnableCitation: default: false description: Whether to show citations in the chat result. type: boolean shouldEnableMultiLanguage: default: false description: Whether to enable multi-language for chat. type: boolean shouldEnableSession: default: true description: Whether or not to enable Session-based chat. type: boolean shouldEnableTrace: default: false description: Whether to show traces in the chat result. type: boolean required: - agentId - compartmentId type: object LlmCustomization: description: 'Configuration to customize LLM. ' properties: instruction: description: If specified, the default instruction is replaced with provided instruction. type: string llmHyperParameters: additionalProperties: type: object description: "Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. \nRefer to the guide for examples and the JSON Schema documentation for details on the format.\n" type: object llmSelection: $ref: '#/components/schemas/LlmSelection' type: object KnowledgeBaseCollection: description: 'Results of a knowledge base search. Contains both KnowledgeBaseSummary items and other information, such as metadata. ' properties: items: description: List of knowledge bases. items: $ref: '#/components/schemas/KnowledgeBaseSummary' type: array required: - items type: object AgentCollection: description: 'Results of an agent search. Contains both AgentSummary items and other information, such as metadata. ' properties: items: description: List of agents. items: $ref: '#/components/schemas/AgentSummary' type: array required: - items type: object ProvisionedCapacityConfig: description: 'The configuration includes the provisioned capacity id and component runtime (tool versions, and other relevant information). ' properties: platformRuntimeConfig: $ref: '#/components/schemas/PlatformRuntimeConfig' provisionedCapacityId: description: An OCID that uniquely identifies an Provisioned Capacity. type: string toolRuntimeConfigs: description: RAG and SQL will be tools. items: $ref: '#/components/schemas/ToolRuntimeConfig' maxItems: 10 type: array required: - provisionedCapacityId type: object WorkRequestResource: description: 'A resource created or operated on by a work request. ' properties: actionType: description: 'The way in which this resource is affected by the operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type that the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier GuardrailConfig: description: The configuration details about whether to apply the guardrail checks to input and output. properties: contentModerationConfig: $ref: '#/components/schemas/ContentModerationGuardrailConfig' personallyIdentifiableInformationConfig: $ref: '#/components/schemas/PersonallyIdentifiableInformationGuardrailConfig' promptInjectionConfig: $ref: '#/components/schemas/PromptInjectionGuardrailConfig' type: object AgentSummary: description: 'Summary information about an agent. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description about the agent. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Agent. type: string knowledgeBaseIds: description: List of [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026. items: type: string type: array lifecycleDetails: description: 'A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the agent. type: string x-obmcs-enumref: '#/definitions/Agent/lifecycleState' llmConfig: $ref: '#/components/schemas/LlmConfig' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the agent was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the agent was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string welcomeMessage: description: Details about purpose and responsibility of the agent type: string required: - id - compartmentId - lifecycleState - timeCreated type: object CreateDataSourceDetails: description: 'The data to create a data source. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the data source in. ' maxLength: 255 minLength: 1 type: string dataSourceConfig: $ref: '#/components/schemas/DataSourceConfig' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the data source. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object knowledgeBaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase. type: string metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object required: - knowledgeBaseId - dataSourceConfig - compartmentId type: object WorkRequestError: description: 'An error encountered while performing an operation that is tracked by a work request. ' properties: code: description: 'A machine-usable code for the error that occurred. For a list of error codes, see [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string timestamp: description: 'The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - code - message - timestamp HumanInputConfig: description: 'Human Input Configuration for an AgentEndpoint. ' properties: shouldEnableHumanInput: description: The Agent will request for human input for disambiguation or additional information gathering if this is enabled. type: boolean required: - shouldEnableHumanInput type: object DataSourceConfig: description: 'The details of data source. ' discriminator: propertyName: dataSourceConfigType properties: dataSourceConfigType: description: 'The type of the tool. ' enum: - OCI_OBJECT_STORAGE type: string shouldEnableMultiModality: default: true description: Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion. type: boolean required: - dataSourceConfigType type: object ToolSummary: description: 'Summary information of a Tool. ' properties: agentId: description: The OCID of the agent that this Tool is attached to. type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description about the Tool. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Tool. type: string lifecycleState: description: The current state of the agent. type: string x-obmcs-enumref: '#/definitions/Tool/lifecycleState' metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the Tool was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the Tool was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string toolConfig: $ref: '#/components/schemas/ToolConfig' required: - id - lifecycleState - timeCreated - compartmentId - agentId - toolConfig type: object ContentModerationGuardrailConfig: description: The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation. properties: inputGuardrailMode: description: An input guardrail mode for content moderation. enum: - DISABLE - BLOCK - INFORM type: string x-obmcs-top-level-enum: '#/definitions/GuardrailMode' outputGuardrailMode: description: An output guardrail mode for content moderation. enum: - DISABLE - BLOCK - INFORM type: string x-obmcs-top-level-enum: '#/definitions/GuardrailMode' type: object ToolRuntimeConfig: description: Configuration for the tool. properties: toolRuntimeConfigType: description: The type of the tool. enum: - RAG - SQL_SMALL - SQL_LARGE type: string version: description: The version of the components. type: string required: - toolRuntimeConfigType type: object WorkRequestErrorCollection: description: 'A list of work request errors. Can contain both errors and other information, such as metadata. ' properties: items: description: A list of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object ContentModerationConfig: description: The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation. properties: shouldEnableOnInput: default: false description: A flag to enable or disable content moderation on input. type: boolean shouldEnableOnOutput: default: false description: A flag to enable or disable content moderation on output. type: boolean type: object CreateProvisionedCapacityDetails: description: 'The data to create a provisioned capacity. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the endpoint in. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the provisioned capacity. maxLength: 255 type: string displayName: description: The name of the provisioned capacity. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object numberOfUnits: description: Provisioned Capacity Unit corresponds to the amount of characters processed per minute. type: integer required: - displayName - numberOfUnits - compartmentId type: object Agent: description: 'An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions. OCI Generative AI Agents supports retrieval-augmented generation (RAG) agents. A RAG agent connects to a data source, retrieves data, and augments model responses with the information from the data sources to generate more relevant responses. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description about the agent. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent. type: string knowledgeBaseIds: description: List of [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026. items: type: string type: array lifecycleDetails: description: 'A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the agent. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string llmConfig: $ref: '#/components/schemas/LlmConfig' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the agent was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the agent was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string welcomeMessage: description: Details about purpose and responsibility of the agent type: string required: - id - compartmentId - lifecycleState - timeCreated type: object UpdateAgentEndpointDetails: description: 'The data to update an endpoint. ' properties: contentModerationConfig: $ref: '#/components/schemas/ContentModerationConfig' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description of the AgentEndpoint. maxLength: 255 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object guardrailConfig: $ref: '#/components/schemas/GuardrailConfig' humanInputConfig: $ref: '#/components/schemas/HumanInputConfig' metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object outputConfig: $ref: '#/components/schemas/OutputConfig' provisionedCapacityConfig: $ref: '#/components/schemas/ProvisionedCapacityConfig' sessionConfig: $ref: '#/components/schemas/SessionConfig' shouldEnableCitation: default: false description: Whether to show citations in the chat result. type: boolean shouldEnableMultiLanguage: default: false description: Whether to enable multi-language for chat. type: boolean shouldEnableTrace: default: false description: Whether to show traces in the chat result. type: boolean type: object ChangeAgentEndpointCompartmentDetails: description: 'The configuration details for the move operation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the endpoint to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object DataIngestionJobType: description: DataIngestionJob type. properties: type: description: Type of ingestionJob. enum: - CLEANUP - INGESTION type: string type: object DataSource: description: 'A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source''s data, so that agents using the knowledge base can refer to the data. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string dataSourceConfig: $ref: '#/components/schemas/DataSourceConfig' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the data source. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source. type: string knowledgeBaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase. type: string lifecycleDetails: description: 'A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the data source. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string metadata: additionalProperties: type: string description: Key-value pairs to allow additional configurations. type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the data source was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the data source was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - knowledgeBaseId - dataSourceConfig - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object WorkRequestLogEntryCollection: description: 'A list of work request logs. Can contain both logs and other information, such as metadata. ' properties: items: description: A list of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string AgentEndpointLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AgentEndpoint/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is `DESC` when sorting by time and `ASC` otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC AgentLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Agent/lifecycleState' schema: type: string DataSourceIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source. in: path name: dataSourceId required: true schema: type: string RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash. ' in: header name: opc-request-id schema: type: string AgentIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent. in: query name: agentId x-default-description: 'null' schema: type: string SortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ProvisionedCapacityIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity. in: query name: provisionedCapacityId x-default-description: 'null' schema: type: string ResourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string WorkRequestStatusQueryParam: description: A filter to return only the resources that match the given lifecycle state. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string ToolLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Tool/lifecycleState' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the given display name exactly. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 KnowledgeBaseLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/KnowledgeBase/lifecycleState' schema: type: string DataIngestionJobLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DataIngestionJob/lifecycleState' schema: type: string ProvisionedCapacityIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity. in: path name: provisionedCapacityId required: true schema: type: string PaginationTokenQueryParam: description: 'For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string minLength: 1 AgentEndpointIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint. in: path name: agentEndpointId required: true schema: type: string KnowledgeBaseIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base. in: path name: knowledgeBaseId required: true schema: type: string WorkRequestIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending. ' in: query name: sortBy schema: type: string enum: - timestamp default: timestamp DataSourceLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DataSource/lifecycleState' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DataIngestionJobIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job. in: path name: dataIngestionJobId required: true schema: type: string DataSourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data source. in: query name: dataSourceId x-default-description: 'null' schema: type: string WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted KnowledgeBaseIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base. in: query name: knowledgeBaseId x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 ToolIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Tool. in: path name: toolId required: true schema: type: string ProvisionedCapacityLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ProvisionedCapacity/lifecycleState' schema: type: string AgentIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the agent. in: path name: agentId required: true schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.gaas.cp