openapi: 3.2.0 info: description: "OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings. \n\nUse the Generative AI service management API to create and manage [dedicated AI clusters](#/en/generative-ai/latest/DedicatedAiCluster/), [endpoints](#/en/generative-ai/latest/Endpoint/), [custom models](#/en/generative-ai/latest/Model/), and [work requests](#/en/generative-ai/latest/WorkRequest/) in the Generative AI service. For example, create a custom model by fine-tuning an out-of-the-box model using your own data, on a fine-tuning dedicated AI cluster. Then, create a hosting dedicated AI cluster with an endpoint to host your custom model. \n\nTo access your custom model endpoints, or to try the out-of-the-box models to generate text, summarize, and create text embeddings see the [Generative AI Inference API](/iaas/api/#/en/generative-ai-inference/latest/).\n\nTo learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).\n" title: Service Management Generative AI API version: '20231130' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/ad2795be339cb04f9138da656375ece69931d84fc358b009d5faf06a73a8f577.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Generative AI Service 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/ad2795be339cb04f9138da656375ece69931d84fc358b009d5faf06a73a8f577.yaml what: the harvested document for Generative AI Service Management API servers: - url: http://127.0.0.1/20231130 - url: https://127.0.0.1/20231130 tags: - name: GenerativeAi paths: /apikeys: get: description: Lists the ApiKeys of a specific compartment. operationId: ListApiKeys parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ApiKeyLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ApiKeyIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ApiKeySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ApiKeySummary 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/ApiKeyCollection' 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 ApiKeys. tags: - GenerativeAi x-related-resource: '#/definitions/ApiKeyCollection' post: description: Creates a new API key in the specified compartment. operationId: CreateApiKey parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Created the apiKey successfully. 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/ApiKey' 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 API key. tags: - GenerativeAi x-related-resource: '#/definitions/ApiKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyDetails' description: Details for the new apiKey. required: true /apikeys/{apiKeyId}: delete: description: Deletes an API key. operationId: DeleteApiKey parameters: - $ref: '#/components/parameters/ApiKeyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The API key is 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 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Deletes an API key. tags: - GenerativeAi x-related-resource: '#/definitions/ApiKey' get: description: Gets information about an API key. operationId: GetApiKey parameters: - $ref: '#/components/parameters/ApiKeyIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The API key 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/ApiKey' 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 API Key tags: - GenerativeAi put: description: Updates the properties of an apiKey. operationId: UpdateApiKey parameters: - $ref: '#/components/parameters/ApiKeyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated the apiKey. 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/ApiKey' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates an ApiKey. tags: - GenerativeAi x-related-resource: '#/definitions/ApiKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApiKeyDetails' description: The information to be updated. required: true /apikeys/{apiKeyId}/actions/changeCompartment: post: description: Moves an API key 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: ChangeApiKeyCompartment parameters: - $ref: '#/components/parameters/ApiKeyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The API key was successfully moved to the specified 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 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 API key into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/ApiKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeApiKeyCompartmentDetails' description: The API key information to be updated. required: true /apikeys/{apiKeyId}/actions/renew: post: description: Renew the primary or secondary key. operationId: RenewApiKey parameters: - $ref: '#/components/parameters/ApiKeyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Renewed the apiKey. 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/ApiKey' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Renew the primary or secondary key. tags: - GenerativeAi x-obmcs-terraform: actionType: special_update x-related-resource: '#/definitions/ApiKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/RenewApiKeyDetails' description: The information to be renewed. required: true /apikeys/{apiKeyId}/actions/setstate: post: description: Set state of the key. operationId: SetApiKeyState parameters: - $ref: '#/components/parameters/ApiKeyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Set the key state. 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/ApiKey' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Set state of the key. tags: - GenerativeAi x-obmcs-terraform: actionType: special_update x-related-resource: '#/definitions/ApiKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/SetApiKeyStateDetails' description: The information for setting key state. required: true /dedicatedAiClusters: get: description: Lists the dedicated AI clusters in a specific compartment. operationId: ListDedicatedAiClusters parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DedicatedAiClusterLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DedicatedAiClusterIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DedicatedAiClusterSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DedicatedAiClusterSummary 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/DedicatedAiClusterCollection' 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 DedicatedAiClusters. tags: - GenerativeAi x-related-resource: '#/definitions/DedicatedAiClusterCollection' post: description: Creates a dedicated AI cluster. operationId: CreateDedicatedAiCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The dedicated AI cluster will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string model-deprecation-info: description: Provides deprecation details for models, included only when a model is deprecated. 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 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/DedicatedAiCluster' 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 DedicatedAiCluster. tags: - GenerativeAi x-related-resource: '#/definitions/DedicatedAiCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDedicatedAiClusterDetails' description: Details for the new dedicated AI cluster. required: true /dedicatedAiClusters/{dedicatedAiClusterId}: delete: description: 'Deletes a dedicated AI cluster. You can only delete clusters without attached resources. Before you delete a hosting dedicated AI cluster, you must delete the endpoints associated to that cluster. Before you delete a fine-tuning dedicated AI cluster, you must delete the custom model on that cluster. The delete action permanently deletes the cluster. This action can''t be undone. ' operationId: DeleteDedicatedAiCluster parameters: - $ref: '#/components/parameters/DedicatedAiClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The dedicated AI cluster 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a dedicated AI cluster. tags: - GenerativeAi x-related-resource: '#/definitions/DedicatedAiCluster' get: description: Gets information about a dedicated AI cluster. operationId: GetDedicatedAiCluster parameters: - $ref: '#/components/parameters/DedicatedAiClusterIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dedicated AI cluster 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/DedicatedAiCluster' 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 DedicatedAiCluster tags: - GenerativeAi put: description: Updates a dedicated AI cluster. operationId: UpdateDedicatedAiCluster parameters: - $ref: '#/components/parameters/DedicatedAiClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The dedicated AI cluster will be updated. 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 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/DedicatedAiCluster' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates a DedicatedAiCluster. tags: - GenerativeAi x-related-resource: '#/definitions/DedicatedAiCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDedicatedAiClusterDetails' description: The information to be updated. required: true /dedicatedAiClusters/{dedicatedAiClusterId}/actions/changeCompartment: post: description: Moves a dedicated AI cluster 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: ChangeDedicatedAiClusterCompartment parameters: - $ref: '#/components/parameters/DedicatedAiClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The dedicated AI cluster was successfully moved to the specified 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 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 DedicatedAiCluster into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/DedicatedAiCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDedicatedAiClusterCompartmentDetails' description: The information to be updated. required: true /endpoints: get: description: Lists the endpoints of a specific compartment. operationId: ListEndpoints parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/EndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/EndpointIdentifierQueryParam' - $ref: '#/components/parameters/PrivateEndpointIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/EndpointSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of EndpointSummary 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/EndpointCollection' 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: - GenerativeAi x-related-resource: '#/definitions/EndpointCollection' post: description: 'Creates an endpoint. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress. ' operationId: CreateEndpoint parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The endpoint will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string model-deprecation-info: description: Provides deprecation details for models, included only when a model is deprecated. 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 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/Endpoint' 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 Endpoint. tags: - GenerativeAi x-related-resource: '#/definitions/Endpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEndpointDetails' description: Details for the new endpoint. required: true /endpoints/{endpointId}: delete: description: Deletes an endpoint. operationId: DeleteEndpoint parameters: - $ref: '#/components/parameters/EndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The endpoint 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an endpoint. tags: - GenerativeAi x-related-resource: '#/definitions/Endpoint' get: description: Gets information about an endpoint. operationId: GetEndpoint parameters: - $ref: '#/components/parameters/EndpointIdentifierPathParam' - $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/Endpoint' 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 Endpoint tags: - GenerativeAi put: description: Updates the properties of an endpoint. operationId: UpdateEndpoint parameters: - $ref: '#/components/parameters/EndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The endpoint will be updated. 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 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/Endpoint' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates a Endpoint. tags: - GenerativeAi x-related-resource: '#/definitions/Endpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEndpointDetails' description: The information to be updated. required: true /endpoints/{endpointId}/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: ChangeEndpointCompartment parameters: - $ref: '#/components/parameters/EndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The endpoint was successfully moved to the specified 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 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 endpoint into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/Endpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeEndpointCompartmentDetails' description: The endpoint information to be updated. required: true /generativeAiPrivateEndpoints: get: description: 'Lists all Generative AI private endpoints in the specified compartment. ' operationId: ListGenerativeAiPrivateEndpoints parameters: - $ref: '#/components/parameters/PrivateEndpointIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/GenerativeAiPrivateEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/GenerativeAiPrivateEndpointSortByQueryParam' - $ref: '#/components/parameters/GenerativeAiPrivateEndpointResourceTypeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Returns a list of Generative AI private endpoints. ' 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/GenerativeAiPrivateEndpointCollection' 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 the Generative AI private endpoints. tags: - GenerativeAi x-example: 'GET /generativeAiPrivateEndpoints?compartmentId=<compartmentId> HTTP/1.1 Host: generativeai.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2025 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/GenerativeAiPrivateEndpointCollection' post: description: 'Creates a Generative AI private endpoint. ' operationId: CreateGenerativeAiPrivateEndpoint parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'Accepted the request. The private endpoint will be created. ' 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 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/GenerativeAiPrivateEndpoint' 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: Create a Generative AI private endpoint. tags: - GenerativeAi x-example: "POST /generativeAiPrivateEndpoints HTTP/1.1\nHost: generativeai.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\" : \"<compartmentId>\",\n \"displayName\": \"pe_1234\",\n \"nsgIds\" : [ \"<nsgId>\" ],\n \"subnetId\" : \"<subnetId>\"\n}\n" x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateGenerativeAiPrivateEndpointDetails' description: 'The parameters required to create a private endpoint. ' required: true /generativeAiPrivateEndpoints/{generativeAiPrivateEndpointId}: delete: description: 'Deletes a Generative AI private endpoint using `privateEndpointId`. ' operationId: DeleteGenerativeAiPrivateEndpoint parameters: - $ref: '#/components/parameters/GenerativeAiPrivateEndpointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Returns the work request ID to track the progress of the delete operation. ' 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Generative AI private endpoint. tags: - GenerativeAi x-example: 'DELETE /generativeAiPrivateEndpoints/<privateEndpointId> HTTP/1.1 Host: generativeai.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2025 14:50:46 GMT Authorization: <authorization and other headers> ' x-related-resource: '#/definitions/GenerativeAiPrivateEndpoint' get: description: 'Retrieves an Generative AI private endpoint using a `privateEndpointId`. ' operationId: GetGenerativeAiPrivateEndpoint parameters: - $ref: '#/components/parameters/GenerativeAiPrivateEndpointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Returns a Generative AI private endpoint. ' 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/GenerativeAiPrivateEndpoint' 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 a Generative AI private endpoint. tags: - GenerativeAi x-example: 'GET /generativeAiPrivateEndpoints/<privateEndpointId> HTTP/1.1 Host: generativeai.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2025 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: 'Updates a Generative AI private endpoint using a `privateEndpointId`. ' operationId: UpdateGenerativeAiPrivateEndpoint parameters: - $ref: '#/components/parameters/GenerativeAiPrivateEndpointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Returns the Generative AI private endpoint metadata and a work request ID to track the progress of the update operation. ' 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 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/GenerativeAiPrivateEndpoint' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Update a Generative AI private endpoint. tags: - GenerativeAi x-example: "PUT /generativeAiPrivateEndpoints/<privateEndpointId> HTTP/1.1\nHost: generativeai.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2025 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"displayName\":\"PE to GEPE\",\n \"dnsZones\" : [ \"app.examplecorp.com\", \"oracle.com\" ],\n \"nsgIds\" : [ \"<nsgId>\" ],\n \"subnetId\" : \"<subnetId>\"\n}\n" x-related-resource: '#/definitions/GenerativeAiPrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateGenerativeAiPrivateEndpointDetails' description: 'Details for updating a Generative AI private endpoint. ' required: true /generativeAiPrivateEndpoints/{generativeAiPrivateEndpointId}/actions/changeCompartment: post: description: 'Moves a Generative AI private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeGenerativeAiPrivateEndpointCompartment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/GenerativeAiPrivateEndpointIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'Accepted the request. Private Endpoint will be moved to the target 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 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Moves a Generative AI private endpoint into a different compartment. tags: - GenerativeAi x-example: "POST /generativeaiPrivateEndpoints/<privateEndpointId>/actions/changeCompartment HTTP/1.1\nHost: generativeai.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2025 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n" x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/GenerativeAiPrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeGenerativeAiPrivateEndpointCompartmentDetails' description: 'Details for changing a Generative AI private endpoint''s compartment. ' required: true /generativeAiProjects: get: description: Lists the generativeAiProjects of a specific compartment. operationId: ListGenerativeAiProjects parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/GenerativeAiProjectLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/GenerativeAiProjectIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/GenerativeAiProjectSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of GenerativeAiProjectSummary 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/GenerativeAiProjectCollection' 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 GenerativeAiProjects. tags: - GenerativeAi x-related-resource: '#/definitions/GenerativeAiProjectCollection' post: description: 'Creates a GenerativeAiProject. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the generativeAiProject creation progress. ' operationId: CreateGenerativeAiProject parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The generativeAiProject will be created. 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 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/GenerativeAiProject' 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 GenerativeAiProject. tags: - GenerativeAi x-related-resource: '#/definitions/GenerativeAiProject' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateGenerativeAiProjectDetails' description: Details for the new generativeAiProject. required: true /generativeAiProjects/{generativeAiProjectId}: delete: description: Deletes a generativeAiProject. operationId: DeleteGenerativeAiProject parameters: - $ref: '#/components/parameters/GenerativeAiProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The generativeAiProject 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a generativeAiProject. tags: - GenerativeAi x-related-resource: '#/definitions/GenerativeAiProject' get: description: Gets information about a generativeAiProject. operationId: GetGenerativeAiProject parameters: - $ref: '#/components/parameters/GenerativeAiProjectIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The generativeAiProject 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/GenerativeAiProject' 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 GenerativeAiProject tags: - GenerativeAi put: description: Updates the properties of a generativeAiProject. operationId: UpdateGenerativeAiProject parameters: - $ref: '#/components/parameters/GenerativeAiProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The generativeAiProject will be updated. 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 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/GenerativeAiProject' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates a GenerativeAiProject. tags: - GenerativeAi x-related-resource: '#/definitions/GenerativeAiProject' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateGenerativeAiProjectDetails' description: The information to be updated. required: true /generativeAiProjects/{generativeAiProjectId}/actions/changeCompartment: post: description: Moves a generativeAiProject 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: ChangeGenerativeAiProjectCompartment parameters: - $ref: '#/components/parameters/GenerativeAiProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The generativeAiProject was successfully moved to the specified 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 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 generativeAiProject into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/GenerativeAiProject' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeGenerativeAiProjectCompartmentDetails' description: The generativeAiProject information to be updated. required: true /hostedApplicationStorages: get: description: Lists the hosted application storage in a specific compartment. operationId: ListHostedApplicationStorages parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/HostedApplicationStorageLifecycleStateQueryParam' - $ref: '#/components/parameters/HostedApplicationStorageTypeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/HostedApplicationStorageIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostedApplicationStorageSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of HostedApplicationStorageSummary 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/HostedApplicationStorageCollection' 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 HostedApplicationStorages. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationStorageCollection' post: description: Creates a hosted application storage. operationId: CreateHostedApplicationStorage parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted application storage will be created. 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 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/HostedApplicationStorage' 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 Hosted Application Storage. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationStorage' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostedApplicationStorageDetails' description: Details for the new hosted application storage. required: true /hostedApplicationStorages/{hostedApplicationStorageId}: delete: description: 'Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can''t be undone. ' operationId: DeleteHostedApplicationStorage parameters: - $ref: '#/components/parameters/HostedApplicationStorageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted application storage 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a hosted application. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationStorage' get: description: Gets information about a hosted application storage. operationId: GetHostedApplicationStorage parameters: - $ref: '#/components/parameters/HostedApplicationStorageIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The hosted application storage 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/HostedApplicationStorage' 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 Hosted Application Storage tags: - GenerativeAi /hostedApplicationStorages/{hostedApplicationStorageId}/actions/changeCompartment: post: description: Moves a hosted application storage 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: ChangeHostedApplicationStorageCompartment parameters: - $ref: '#/components/parameters/HostedApplicationStorageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The hosted application storage was successfully moved to the specified 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 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 Application Storage into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationStorage' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostedApplicationStorageCompartmentDetails' description: The information to be updated. required: true /hostedApplications: get: description: Lists the hosted applications in a specific compartment. operationId: ListHostedApplications parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/HostedApplicationLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/HostedApplicationIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostedApplicationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of HostedApplicationSummary 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/HostedApplicationCollection' 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 HostedApplications. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationCollection' post: description: Creates a hosted application. operationId: CreateHostedApplication parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The hosted application will be created. 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 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/HostedApplication' 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 HostedApplication. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplication' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostedApplicationDetails' description: Details for the new hosted application. required: true /hostedApplications/{hostedApplicationId}: delete: description: 'Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can''t be undone. ' operationId: DeleteHostedApplication parameters: - $ref: '#/components/parameters/HostedApplicationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted application 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a hosted application. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplication' get: description: Gets information about a hosted application. operationId: GetHostedApplication parameters: - $ref: '#/components/parameters/HostedApplicationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The hosted application 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/HostedApplication' 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 HostedApplication tags: - GenerativeAi put: description: Updates a hosted application. operationId: UpdateHostedApplication parameters: - $ref: '#/components/parameters/HostedApplicationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted application 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a HostedApplication. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplication' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHostedApplicationDetails' description: The information to be updated. required: true /hostedApplications/{hostedApplicationId}/actions/changeCompartment: post: description: Moves a hosted application 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: ChangeHostedApplicationCompartment parameters: - $ref: '#/components/parameters/HostedApplicationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The hosted application was successfully moved to the specified 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 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 HostedApplication into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplication' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostedApplicationCompartmentDetails' description: The information to be updated. required: true /hostedApplicationsIam: get: description: Lists the hosted applications in a specific compartment. operationId: ListHostedApplicationsIam parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/HostedApplicationLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/HostedApplicationIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostedApplicationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of HostedApplicationSummary 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/HostedApplicationCollection' 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 HostedApplicationsIam. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationCollection' post: description: Creates a hosted application. operationId: CreateHostedApplicationIam parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The hosted application will be created. 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 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/HostedApplicationIam' 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 HostedApplicationIam. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationIam' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostedApplicationIamDetails' description: Details for the new hosted application. required: true /hostedApplicationsIam/{hostedApplicationIamId}: delete: description: 'Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can''t be undone. ' operationId: DeleteHostedApplicationIam parameters: - $ref: '#/components/parameters/HostedApplicationIamIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted application 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a hosted application. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationIam' get: description: Gets information about a hosted application. operationId: GetHostedApplicationIam parameters: - $ref: '#/components/parameters/HostedApplicationIamIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The hosted application 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/HostedApplicationIam' 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 HostedApplicationIam tags: - GenerativeAi put: description: Updates a hosted application. operationId: UpdateHostedApplicationIam parameters: - $ref: '#/components/parameters/HostedApplicationIamIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted application 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a HostedApplicationIam. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationIam' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHostedApplicationIamDetails' description: The information to be updated. required: true /hostedApplicationsIam/{hostedApplicationIamId}/actions/changeCompartment: post: description: Moves a hosted application 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: ChangeHostedApplicationIamCompartment parameters: - $ref: '#/components/parameters/HostedApplicationIamIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The hosted application was successfully moved to the specified 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 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 HostedApplicationIam into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/HostedApplicationIam' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostedApplicationCompartmentDetails' description: The information to be updated. required: true /hostedDeployments: get: description: Lists the hosted applications in a specific compartment. Provide either applicationId or applicationIamId to filter by parent. operationId: ListHostedDeployments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ApplicationIdQueryParam' - $ref: '#/components/parameters/HostedDeploymentLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/HostedDeploymentIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostedDeploymentSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of HostedDeploymentSummary 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/HostedDeploymentCollection' 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 HostedDeployments. tags: - GenerativeAi x-related-resource: '#/definitions/HostedDeploymentCollection' post: description: Creates a hosted deployment. operationId: CreateHostedDeployment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The hosted deployment will be created. 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 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/HostedDeployment' 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 HostedDeployment. tags: - GenerativeAi x-related-resource: '#/definitions/HostedDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostedDeploymentDetails' description: Details for the new hosted deployment. required: true /hostedDeployments/{hostedDeploymentId}: delete: description: 'Deletes a hosted deployment. You can only delete hosted deployment without attached resources. Before you delete a hosting hosted deployment, you must delete the endpoints associated to that deployment. Before you delete a fine-tuning hosted deployment, you must delete the custom model on that deployment. The delete action permanently deletes the cluster. This action can''t be undone. ' operationId: DeleteHostedDeployment parameters: - $ref: '#/components/parameters/HostedDeploymentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted deployment 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a hosted deployment. tags: - GenerativeAi x-related-resource: '#/definitions/HostedDeployment' get: description: Gets information about a hosted deployment. operationId: GetHostedDeployment parameters: - $ref: '#/components/parameters/HostedDeploymentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The hosted deployment 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/HostedDeployment' 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 Hosted Deployment tags: - GenerativeAi put: description: Updates a hosted deployment. operationId: UpdateHostedDeployment parameters: - $ref: '#/components/parameters/HostedDeploymentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The hosted deployment will be updated. 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 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/HostedDeployment' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates a HostedDeployment. tags: - GenerativeAi x-related-resource: '#/definitions/HostedDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHostedDeploymentDetails' description: update hosted deployment. required: true /hostedDeployments/{hostedDeploymentId}/artifacts: post: description: add image with isAutoDeploy flag. operationId: AddArtifact parameters: - $ref: '#/components/parameters/HostedDeploymentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The new artifact will be added. 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create Simple Docker Artifact tags: - GenerativeAi x-related-resource: '#/definitions/HostedDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddArtifactDetails' description: Details for the new artifact. required: true /hostedDeployments/{hostedDeploymentId}/artifacts/{artifactId}: delete: description: delete artifact. operationId: DeleteHostedDeploymentArtifact parameters: - $ref: '#/components/parameters/HostedDeploymentIdentifierPathParam' - $ref: '#/components/parameters/ArtifactIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The artifact will be removed. 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: delete artifact tags: - GenerativeAi x-related-resource: '#/definitions/HostedDeployment' /importedModels: get: description: Lists imported models in a specific compartment. operationId: ListImportedModels parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ImportedModelVendorQueryParam' - $ref: '#/components/parameters/ImportedModelCapabilityQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ImportedModelLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ImportedModelIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ImportedModelSortByQueryParam' responses: 200: description: Returns an ImportedModelCollection 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/ImportedModelCollection' 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: Lists the currently available imported models. tags: - GenerativeAi x-related-resource: '#/definitions/ImportedModelCollection' post: description: 'Import a model from ModelDataSource. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the importedModel creation progress. ' operationId: CreateImportedModel parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The model will be imported. 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 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/ImportedModel' 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: Import a model. tags: - GenerativeAi x-related-resource: '#/definitions/ImportedModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateImportedModelDetails' description: Details for importing a model. required: true /importedModels/{importedModelId}: delete: description: Deletes an imported model. An imported model shouldn't be deleted if there's one or more active endpoints associated with that imported model. operationId: DeleteImportedModel parameters: - $ref: '#/components/parameters/ImportedModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The importedModel 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 importedModel. tags: - GenerativeAi x-related-resource: '#/definitions/ImportedModel' get: description: Gets information about an imported model. operationId: GetImportedModel parameters: - $ref: '#/components/parameters/ImportedModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The importedModel 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/ImportedModel' 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: Retrieves a single imported model resource, providing basic information about the imported model tags: - GenerativeAi put: description: Updates the properties of an imported model such as name, description, freeform tags, and defined tags. operationId: UpdateImportedModel parameters: - $ref: '#/components/parameters/ImportedModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The imported model was updated. 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 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/ImportedModel' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates an ImportedModel. tags: - GenerativeAi x-related-resource: '#/definitions/ImportedModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateImportedModelDetails' description: The model information to be updated. required: true /importedModels/{importedModelId}/actions/changeCompartment: post: description: Moves an imported model into a different compartment. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). operationId: ChangeImportedModelCompartment parameters: - $ref: '#/components/parameters/ImportedModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The imported model was successfully moved to the specified 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 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 imported model into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/ImportedModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeImportedModelCompartmentDetails' description: The information to be updated. required: true /models: get: description: Lists the models in a specific compartment. Includes pretrained base models and fine-tuned custom models. operationId: ListModels parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ModelVendorQueryParam' - $ref: '#/components/parameters/CapabilityQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ModelLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ModelIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ModelSortByQueryParam' responses: 200: description: Returns a ModelCollection 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/ModelCollection' 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: Lists the currently available models. tags: - GenerativeAi x-related-resource: '#/definitions/ModelCollection' post: description: 'Creates a custom model by fine-tuning a base model with your own dataset. You can create a new custom models or create a new version of existing custom model.. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress. ' operationId: CreateModel parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The model will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string model-deprecation-info: description: Provides deprecation details for models, included only when a model is deprecated. 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 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/Model' 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 Model. tags: - GenerativeAi x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModelDetails' description: Details for the new model. required: true /models/{modelId}: delete: description: Deletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with that model. operationId: DeleteModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The model 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 model. tags: - GenerativeAi x-related-resource: '#/definitions/Model' get: description: Gets information about a custom model. operationId: GetModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The model 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/Model' 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: Retrieves a single model resource, providing basic information about the model tags: - GenerativeAi put: description: Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags. operationId: UpdateModel parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The model was updated. 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/Model' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates a Model. tags: - GenerativeAi x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelDetails' description: The model information to be updated. required: true /models/{modelId}/actions/changeCompartment: post: description: Moves a custom model into a different compartment. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). operationId: ChangeModelCompartment parameters: - $ref: '#/components/parameters/ModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The model was successfully moved to the specified 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 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 Model into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelCompartmentDetails' description: The information to be updated. required: true /semanticStores: get: description: Lists the SemanticStores given specific filter. operationId: ListSemanticStores parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/SemanticStoreLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SemanticStoreIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SemanticStoreSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SemanticStoreQueryingConnectionIdQueryParam' responses: 200: description: A page of SemanticStoreSummary 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/SemanticStoreCollection' 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 SemanticStores. tags: - GenerativeAi x-related-resource: '#/definitions/SemanticStoreCollection' post: description: 'Creates a SemanticStore. ' operationId: CreateSemanticStore parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The SemanticStore is created successfully. 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 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/SemanticStore' 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 SemanticStore. tags: - GenerativeAi x-related-resource: '#/definitions/SemanticStore' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSemanticStoreDetails' description: Details for the new SemanticStore. required: true /semanticStores/{semanticStoreId}: delete: description: Deletes a semanticStore. operationId: DeleteSemanticStore parameters: - $ref: '#/components/parameters/SemanticStoreIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the semanticStore. 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a semanticStore. tags: - GenerativeAi x-related-resource: '#/definitions/SemanticStore' get: description: Gets information about a semanticStore. operationId: GetSemanticStore parameters: - $ref: '#/components/parameters/SemanticStoreIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The SemanticStore 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/SemanticStore' 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 SemanticStore tags: - GenerativeAi put: description: Updates the properties of a SemanticStore. operationId: UpdateSemanticStore parameters: - $ref: '#/components/parameters/SemanticStoreIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The SemanticStore is updated successfully. 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/SemanticStore' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates a SemanticStore. tags: - GenerativeAi x-related-resource: '#/definitions/SemanticStore' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSemanticStoreDetails' description: The information to be updated. required: true /semanticStores/{semanticStoreId}/actions/changeCompartment: post: description: Moves a SemanticStore 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: ChangeSemanticStoreCompartment parameters: - $ref: '#/components/parameters/SemanticStoreIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted to move a semantic store from one compartment to another. 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 SemanticStore into a different compartment. tags: - GenerativeAi x-related-resource: '#/definitions/SemanticStore' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSemanticStoreCompartmentDetails' description: The SemanticStore information to be updated. required: true /vectorStoreConnectorFileSyncs: get: description: Lists the vectorStoreConnectorFileSyncs of a specific compartment. operationId: ListVectorStoreConnectorFileSyncs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VectorStoreConnectorFileSyncLifecycleStateQueryParam' - $ref: '#/components/parameters/VectorStoreConnectorFileSyncIdentifierQueryParam' - $ref: '#/components/parameters/VectorStoreConnectorIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/VectorStoreConnectorFileSyncSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of VectorStoreConnectorFileSyncSummary 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/VectorStoreConnectorFileSyncCollection' 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 VectorStoreConnectorFileSyncs. tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnectorFileSyncCollection' post: description: 'Creates a File Sync operation for a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnectorFileSync creation progress. ' operationId: CreateVectorStoreConnectorFileSync parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The vectorStoreConnectorFileSync will be created. 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 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/VectorStoreConnectorFileSync' 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 File Sync operation for a VectorStoreConnector. tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnectorFileSync' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVectorStoreConnectorFileSyncDetails' description: Details for the new vectorStoreConnectorFileSync. required: true /vectorStoreConnectorFileSyncs/{vectorStoreConnectorFileSyncId}: delete: description: Cancels a vectorStoreConnectorFileSync. operationId: CancelVectorStoreConnectorFileSync parameters: - $ref: '#/components/parameters/VectorStoreConnectorFileSyncIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The vectorStoreConnector 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancels a vectorStoreConnectorFileSync operation. tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnectorFileSync' get: description: Gets information about a vectorStoreConnectorFileSync. operationId: GetVectorStoreConnectorFileSync parameters: - $ref: '#/components/parameters/VectorStoreConnectorFileSyncIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The vectorStoreConnectorFileSync 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/VectorStoreConnectorFileSync' 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 the details of a VectorStoreConnectorFileSync Operation. tags: - GenerativeAi /vectorStoreConnectorFileSyncs/{vectorStoreConnectorFileSyncId}/ingestionLogs: get: description: Gets Ingestion logs for a vectorStoreConnectorFileSync operation. operationId: ListVectorStoreConnectorFileSyncIngestionLogs parameters: - $ref: '#/components/parameters/VectorStoreConnectorFileSyncIdentifierPathParam' - $ref: '#/components/parameters/VectorStoreConnectorFileSyncLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FileSyncIngestionLogsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A page of FileSyncIngestionLogs 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/FileSyncIngestionLogsCollection' 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 Ingestion logs for a VectorStoreConnectorFileSync operation. tags: - GenerativeAi x-related-resource: '#/definitions/FileSyncIngestionLogsCollection' /vectorStoreConnectors: get: description: Lists the vectorStoreConnectors of a specific compartment. operationId: ListVectorStoreConnectors parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VectorStoreIdentifierQueryParam' - $ref: '#/components/parameters/VectorStoreConnectorLifecycleStateQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/VectorStoreConnectorIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/VectorStoreConnectorSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of VectorStoreConnectorSummary 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/VectorStoreConnectorCollection' 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 VectorStoreConnectors. tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnectorCollection' post: description: 'Creates a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnector creation progress. ' operationId: CreateVectorStoreConnector parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The vectorStoreConnector will be created. 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 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/VectorStoreConnector' 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 VectorStoreConnector. tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnector' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVectorStoreConnectorDetails' description: Details for the new vectorStoreConnector. required: true /vectorStoreConnectors/{vectorStoreConnectorId}: delete: description: Deletes a vectorStoreConnector. operationId: DeleteVectorStoreConnector parameters: - $ref: '#/components/parameters/VectorStoreConnectorIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The vectorStoreConnector 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a vectorStoreConnector. tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnector' get: description: Gets information about a vectorStoreConnector. operationId: GetVectorStoreConnector parameters: - $ref: '#/components/parameters/VectorStoreConnectorIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The vectorStoreConnector 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/VectorStoreConnector' 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 VectorStoreConnector tags: - GenerativeAi put: description: Updates the properties of a vectorStoreConnector. operationId: UpdateVectorStoreConnector parameters: - $ref: '#/components/parameters/VectorStoreConnectorIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The vectorStoreConnector will be updated. 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 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/VectorStoreConnector' 400: $ref: '#/components/responses/400' 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' default: $ref: '#/components/responses/default' summary: Updates a VectorStoreConnector. tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnector' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVectorStoreConnectorDetails' description: The information to be updated. required: true /vectorStoreConnectors/{vectorStoreConnectorId}/ingestionLogs: get: description: Gets Ingestion logs for a vectorStoreConnector. operationId: ListVectorStoreConnectorIngestionLogs parameters: - $ref: '#/components/parameters/VectorStoreConnectorIdentifierPathParam' - $ref: '#/components/parameters/VectorStoreConnectorFileStatusQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IngestionLogsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A page of VectorStoreConnectorIngestionLogs 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/VectorStoreConnectorIngestionLogsCollection' 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 Ingestion logs for a VectorStoreConnector tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnectorIngestionLogsCollection' /vectorStoreConnectors/{vectorStoreConnectorId}/stats: get: description: Gets Sync statistics from a vectorStoreConnector. operationId: GetVectorStoreConnectorStats parameters: - $ref: '#/components/parameters/VectorStoreConnectorIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The vectorStoreConnectorStats 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/VectorStoreConnectorStats' 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 Sync statistics of a VectorStoreConnector tags: - GenerativeAi x-related-resource: '#/definitions/VectorStoreConnectorStats' /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: - GenerativeAi x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: 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: - GenerativeAi 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: - GenerativeAi 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: Lists the work request logs. tags: - GenerativeAi x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: CreateImportedModelDetails: description: The data to import a model. properties: capabilities: description: Specifies the intended use or supported capabilities of the imported model. items: enum: - TEXT_TO_TEXT - IMAGE_TEXT_TO_TEXT - EMBEDDING - RERANK type: string x-obmcs-top-level-enum: '#/definitions/ImportedModelCapability' type: array compartmentId: description: The compartment OCID from which the model is imported. maxLength: 255 minLength: 1 type: string dataSource: $ref: '#/components/schemas/ModelDataSource' 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 imported model. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name for the imported model. 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 vendor: description: The provider of the imported model. maxLength: 255 minLength: 1 type: string version: description: The version of the imported model. maxLength: 255 minLength: 1 type: string required: - compartmentId - dataSource type: object StandardLongTermMemoryStrategy: description: Standard strategy settings for long-term memory. properties: embeddingConfig: $ref: '#/components/schemas/EmbeddingConfig' extractionConfig: $ref: '#/components/schemas/ExtractionConfig' isEnabled: description: Indicates whether long-term memory is enabled. type: boolean required: - isEnabled type: object UpdateGenerativeAiPrivateEndpointDetails: description: 'The details required to update a Generative AI private endpoint. ' 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 user friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dnsPrefix: description: 'dnsPrefix of the private endpoint FQDN. ' maxLength: 20 minLength: 2 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 isAllowOnDemand: description: 'Flag that allows access to on-demand models using this private endpoint. ' type: boolean nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to add the private endpoint''s VNIC to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object 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 CreateEndpointDetails: description: The data to create an endpoint. properties: compartmentId: description: The compartment OCID to create the endpoint in. maxLength: 255 minLength: 1 type: string contentModerationConfig: $ref: '#/components/schemas/ContentModerationConfig' dedicatedAiClusterId: description: The OCID of the dedicated AI cluster on which a model will be deployed to. 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 endpoint. maxLength: 400 minLength: 1 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 generativeAiPrivateEndpointId: description: The OCID of the Generative AI private endpoint to which this endpoint is attached to. maxLength: 255 minLength: 1 type: string modelId: description: The OCID of the model that's used to create this endpoint. maxLength: 255 minLength: 1 type: string piiDetectionConfig: $ref: '#/components/schemas/PiiDetectionConfig' promptInjectionConfig: $ref: '#/components/schemas/PromptInjectionConfig' required: - compartmentId - modelId - dedicatedAiClusterId type: object FineTuneDetails: description: 'Details about fine-tuning a custom model. ' properties: dedicatedAiClusterId: description: The OCID of the dedicated AI cluster this fine-tuning runs on. type: string trainingConfig: $ref: '#/components/schemas/TrainingConfig' trainingDataset: $ref: '#/components/schemas/Dataset' required: - trainingDataset - dedicatedAiClusterId DedicatedAiClusterCapacity: description: The total capacity for a dedicated AI cluster. discriminator: propertyName: capacityType properties: capacityType: description: The type of the dedicated AI cluster capacity. enum: - HOSTING_CAPACITY type: string required: - capacityType HostedDeploymentSummary: description: Summary information about a hosted deployment. properties: activeArtifact: $ref: '#/components/schemas/Artifact' artifacts: description: array of Artifacts. items: $ref: '#/components/schemas/Artifact' type: array 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 hostedApplicationId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HostedApplication parent. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. type: string lifecycleState: description: 'The current state of the hosted deployment. Allowed values are: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/HostedDeployment/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 hosted deployment was created, in the format defined by RFC 3339. format: date-time type: string timeUpdated: description: The date and time the hosted deployment was updated, in the format defined by RFC 3339. format: date-time type: string required: - id - lifecycleState type: object PiiDetectionConfig: description: The configuration details for personally identifiable information (PII) detection, in prompts and responses. properties: isEnabled: description: Whether to enable the PII detection feature. type: boolean mode: default: INFORM description: The mode of operation for PII detection. type: string x-obmcs-enumref: '#/definitions/ContentModerationConfig/mode' modelId: description: The OCID of the model used for the feature. type: string required: - isEnabled type: object ChangeImportedModelCompartmentDetails: description: 'The details to move an imported model to another compartment. ' properties: compartmentId: description: The destination compartment OCID maxLength: 255 minLength: 1 type: string required: - compartmentId type: object AddArtifactDetails: description: new artifact details. properties: artifact: $ref: '#/components/schemas/CreateArtifactDetails' 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 required: - artifact type: object Artifact: description: Container/artifact configuration for the deployment. discriminator: propertyName: artifactType properties: artifactType: description: The type of the artifact. enum: - SIMPLE_DOCKER_ARTIFACT type: string hostedDeploymentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the application. type: string id: description: if put artifact to a table, the id is needed type: string isVulnerabilityScanRequired: default: false description: 'Optional flag that requires an OCI Vulnerability Scanning Service compliance report for this artifact before it can become active. When not provided, the value defaults to false and the artifact is not blocked on a scan result. ' type: boolean status: description: The current status of the artifact. enum: - ACTIVE - INACTIVE - UPDATING - FAILED type: string timeCreated: description: The date and time the artifact was created. format: date-time type: string type: object CreateDedicatedAiClusterDetails: description: The data to create a dedicated AI cluster. properties: compartmentId: description: The compartment OCID to create the dedicated AI cluster 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 dedicated AI cluster. maxLength: 400 minLength: 1 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 type: description: 'The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor. Allowed values are: - HOSTING - FINE_TUNING ' type: string x-obmcs-enumref: '#/definitions/DedicatedAiCluster/type' unitCount: description: The number of dedicated units in this AI cluster. minimum: 1 type: integer unitShape: description: 'The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers. Allowed values are: - LARGE_COHERE - LARGE_COHERE_V2 - SMALL_COHERE - SMALL_COHERE_V2 - SMALL_COHERE_4 - EMBED_COHERE - LLAMA2_70 - LARGE_GENERIC - LARGE_COHERE_V2_2 - LARGE_GENERIC_4 - SMALL_GENERIC_V2 - LARGE_GENERIC_2 - LARGE_GENERIC_V3 - LARGE_COHERE_V3 - RERANK_COHERE - SMALL_GENERIC_V1 - MEDIUM_GENERIC_V1 - LARGE_GENERIC_V1 - A10_X1 - A10_X2 - A10_X4 - A100_40G_X1 - A100_40G_X2 - A100_40G_X4 - A100_40G_X8 - A100_80G_X1 - A100_80G_X2 - A100_80G_X4 - A100_80G_X8 - H100_X1 - H100_X2 - H100_X4 - H100_X8 - H200_X1 - H200_X2 - H200_X4 - H200_X8 The following shapes can only be used to deploy imported models: - A10_X1, A10_X2, A10_X4 - A100_40G_X1, A100_40G_X2, A100_40G_X4, A100_40G_X8 - A100_80G_X1, A100_80G_X2, A100_80G_X4, A100_80G_X8 - H100_X1, H100_X2, H100_X4, H100_X8 - H200_X1, H200_X2, H200_X4, H200_X8 - OAI_A10_X2 - OAI_H100_X1 - OAI_H100_X2 - OAI_H200_X1 - OAI_A100_80G_X1 - OAI_A100_80G_X2 - OAI_A100_40G_X1 - OAI_A100_40G_X4 ' type: string x-obmcs-enumref: '#/definitions/DedicatedAiCluster/unitShape' required: - type - compartmentId - unitCount - unitShape type: object UpdateHostedApplicationDetails: allOf: - $ref: '#/components/schemas/UpdateHostedApplicationBaseDetails' - properties: inboundAuthConfig: $ref: '#/components/schemas/InboundAuthConfig' type: object description: The data to update a hosted application. ModelConfig: description: Base model configuration shared across GenAI Project memory. discriminator: propertyName: modelConfigType properties: llmSelection: $ref: '#/components/schemas/LlmSelection' modelConfigType: description: The stage-specific config type. enum: - EXTRACTION - EMBEDDING - CONDENSER type: string required: - modelConfigType - llmSelection type: object ModelCollection: description: 'Results of a model search. Contains ModelSummary items and other information such as metadata. ' properties: items: description: The results of a model search. items: $ref: '#/components/schemas/ModelSummary' type: array required: - items type: object EmbeddingConfig: allOf: - $ref: '#/components/schemas/ModelConfig' - discriminator: EMBEDDING type: object description: Configuration for generating embeddings from extracted information. type: object CreateGenerativeAiPrivateEndpointDetails: description: 'The details required to create a Generative AI private endpoint. ' properties: compartmentId: description: 'The OCID of the compartment where the private endpoint is created. ' 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 description of this private endpoint. ' maxLength: 400 minLength: 1 type: string displayName: description: 'A user friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dnsPrefix: description: 'dnsPrefix of the private endpoint FQDN. ' maxLength: 20 minLength: 2 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 isAllowOnDemand: default: false description: 'Flag that allows access to on-demand models using this private endpoint. ' type: boolean nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to add the private endpoint''s VNIC to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true resourceType: default: ENDPOINT description: 'The resource type that Generative AI private endpoint can be used for. ' type: string x-obmcs-enumref: '#/definitions/GenerativeAiPrivateEndpoint/resourceType' securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object subnetId: description: 'The OCID of the customer''s subnet where the private endpoint VNIC will reside. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - subnetId - dnsPrefix type: object WorkRequestSummaryCollection: description: A list of work requests. Can contain 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 CreateSchemasDetails: description: Array of database schemas or other database objects to include in enrichment pipeline. discriminator: propertyName: connectionType properties: connectionType: description: Specifies the type of underlying connection. enum: - DATABASE_TOOLS_CONNECTION type: string required: - connectionType type: object GenerativeAiPrivateEndpoint: description: 'Generative AI private endpoint. ' properties: compartmentId: description: 'The OCID of the compartment that contains the private endpoint. ' 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 description of this private endpoint. ' maxLength: 400 minLength: 1 type: string displayName: description: 'A user friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string fqdn: description: 'Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com) ' 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 of a private endpoint. ' maxLength: 255 minLength: 1 type: string isAllowOnDemand: default: false description: 'Flag that allows access to on-demand models using this private endpoint. ' type: boolean lifecycleDetails: description: 'The detailed messages about the lifecycle state ' maxLength: 400 minLength: 1 type: string lifecycleState: description: 'The current state of the Generative AI Private Endpoint. ' enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string nsgIds: description: 'A list of the OCIDs of the network security groups that the private endpoint''s VNIC belongs to. ' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true previousState: $ref: '#/components/schemas/GenerativeAiPrivateEndpoint' privateEndpointIp: description: 'The private IP address (in the customer''s VCN) that represents the access point for the associated endpoint service. ' maxLength: 40 minLength: 2 type: string resourceType: description: 'The resource type that Generative AI private endpoint can be used for. ' enum: - APPLICATION - ENDPOINT type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object subnetId: description: 'The OCID of the subnet that the private endpoint belongs to. ' maxLength: 255 minLength: 1 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 that the Generative AI private endpoint was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time that the Generative AI private endpoint was updated expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - subnetId - lifecycleState - fqdn - timeCreated - timeUpdated type: object CreateHostedApplicationIamDetails: allOf: - $ref: '#/components/schemas/CreateHostedApplicationBaseDetails' description: The details required to create a hosted application. ChangeHostedApplicationStorageCompartmentDetails: description: The details to move a hosted application storage to another compartment. properties: compartmentId: description: The OCID of the compartment to move the hosted application storage to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Model: description: 'You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model. Have your dataset ready before you create a custom model. See [Training Data Requirements](/iaas/Content/generative-ai/training-data-requirements.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm). ' properties: baseModelId: description: The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null. type: string capabilities: description: Describes what this model can be used for. items: enum: - TEXT_GENERATION - TEXT_SUMMARIZATION - TEXT_EMBEDDINGS - FINE_TUNE - CHAT - TEXT_RERANK type: string x-obmcs-top-level-enum: '#/definitions/ModelCapability' type: array compartmentId: description: The compartment OCID for fine-tuned models. For pretrained models, this value is null. 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 model. type: string displayName: description: A user-friendly name. type: string fineTuneDetails: $ref: '#/components/schemas/FineTuneDetails' 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: An ID that uniquely identifies a pretrained or fine-tuned model. type: string isLongTermSupported: description: Whether a model is supported long-term. Only applicable to base models. type: boolean lifecycleDetails: description: A message describing the current state of the model in more detail that can provide actionable information. type: string lifecycleState: description: The lifecycle state of the model. enum: - ACTIVE - CREATING - DELETING - DELETED - FAILED type: string modelMetrics: $ref: '#/components/schemas/ModelMetrics' previousState: $ref: '#/components/schemas/Model' 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 that the model was created in the format of an RFC3339 datetime string. format: date-time type: string timeDedicatedRetired: description: The timestamp indicating when the custom model and its associated foundation model will be fully retired. format: date-time type: string timeDeprecated: description: Corresponds to the time when the custom model and its associated foundation model will be deprecated. format: date-time type: string timeOnDemandRetired: description: The timestamp indicating when the base model will no longer be available for on-demand usage. format: date-time type: string timeUpdated: description: The date and time that the model was updated in the format of an RFC3339 datetime string. format: date-time type: string type: description: The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model. enum: - BASE - CUSTOM type: string vendor: description: The provider of the base model. type: string version: description: The version of the model. type: string required: - id - compartmentId - timeCreated - capabilities - lifecycleState - type type: object ApiKeyItem: description: The ApiKey item. properties: key: description: The key. type: string keyMask: description: The masked key. type: string keyName: description: The key name. type: string state: description: The current state of the API key item. enum: - ACTIVE - INACTIVE - REVOKED - EXPIRED - DELETED type: string timeActivated: description: The date and time that the key is activated in the format of an RFC3339 datetime string. format: date-time type: string timeCreated: description: The date and time that the key was created in the format of an RFC3339 datetime string. format: date-time type: string timeDeactivated: description: The date and time that the key is deactivated in the format of an RFC3339 datetime string. format: date-time type: string timeExpiry: description: The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339. format: date-time type: string timeLastUsed: description: The date and time that the key is last used in the format of an RFC3339 datetime string. format: date-time type: string timeRevoked: description: The date and time that the key is revoked in the format of an RFC3339 datetime string. format: date-time type: string required: - keyName - keyMask - timeCreated - timeExpiry - state type: object FileSyncIngestionLogs: description: A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector 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 durationInSeconds: description: The duration taken(in seconds) to ingest the File. type: integer fileId: description: An identifier that identifies a File ingested to a VectorStore. type: string filePath: description: The path where the file was located in the datasource. type: string fileSizeInBytes: description: The size of the file. type: integer 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 status: description: The current status of ingestion for the File enum: - COMPLETED - CANCELLED - FAILED - QUEUED - IN_PROGRESS 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 totalChunksCreated: description: The total number of chunks created from the File. type: integer required: - fileId - filePath - status type: object VectorStoreConnectorIngestionLogs: description: A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector 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 durationInSeconds: description: The duration taken(in seconds) to ingest the File. type: integer fileId: description: An identifier that identifies a File ingested to a VectorStore. type: string filePath: description: The path where the file was located in the datasource. type: string fileSizeInBytes: description: The size of the file. type: integer 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 status: description: The current status of ingestion for the File enum: - COMPLETED - CANCELLED - FAILED - QUEUED - IN_PROGRESS 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 totalChunksCreated: description: The total number of chunks created from the File. type: integer vectorStoreConnectorFileSyncId: description: An identifier that identifies the FileSync operation that added this file for ingestion. type: string required: - fileId - filePath - status type: object CreateHostedApplicationDetails: allOf: - $ref: '#/components/schemas/CreateHostedApplicationBaseDetails' - properties: inboundAuthConfig: $ref: '#/components/schemas/InboundAuthConfig' required: - inboundAuthConfig type: object description: The details required to create a hosted application. ModelSummary: description: 'Summary of the model. ' properties: baseModelId: description: The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null. type: string capabilities: description: Describes what this model can be used for. items: enum: - TEXT_GENERATION - TEXT_SUMMARIZATION - TEXT_EMBEDDINGS - FINE_TUNE - CHAT - TEXT_RERANK type: string x-obmcs-top-level-enum: '#/definitions/ModelCapability' type: array compartmentId: description: The compartment OCID for fine-tuned models. For pretrained models, this value is null. 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 displayName: description: A user-friendly name. type: string fineTuneDetails: $ref: '#/components/schemas/FineTuneDetails' 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: An ID that uniquely identifies a pretrained or a fine-tuned model. type: string isLongTermSupported: description: Whether a model is supported long-term. Applies only to base models. type: boolean lifecycleDetails: description: A message describing the current state of the model with detail that can provide actionable information. type: string lifecycleState: description: 'The lifecycle state of the model. Allowed values are: - ACTIVE - CREATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/Model/lifecycleState' modelMetrics: $ref: '#/components/schemas/ModelMetrics' 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 that the model was created in the format of an RFC3339 datetime string. format: date-time type: string timeDedicatedRetired: description: The timestamp indicating when the custom model and its associated foundation model will be fully retired. format: date-time type: string timeDeprecated: description: Corresponds to the time when the custom model and its associated foundation model will be deprecated. format: date-time type: string timeOnDemandRetired: description: The timestamp indicating when the base model will no longer be available for on-demand usage. format: date-time type: string type: description: 'The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model. Allowed values are: - BASE - CUSTOM ' type: string x-obmcs-enumref: '#/definitions/Model/type' vendor: description: The provider of the model. type: string version: description: The version of the model. type: string required: - id - compartmentId - timeCreated - capabilities - lifecycleState - type type: object GenerativeAiProjectSummary: description: Summary information for a GenerativeAiProject. properties: compartmentId: description: Owning compartment OCID for a GenerativeAiProject. 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 GenerativeAiProject. 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: An OCID that uniquely identifies a GenerativeAiProject. type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: 'The current state of the GenerativeAiProject. Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/GenerativeAiProject/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 that the generativeAiProject was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the generativeAiProject was updated in the format of an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object UpdateHostedApplicationIamDetails: allOf: - $ref: '#/components/schemas/UpdateHostedApplicationBaseDetails' description: The data to update a hosted application. 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_MODEL - DELETE_MODEL - MOVE_MODEL - CREATE_DEDICATED_AI_CLUSTER - DELETE_DEDICATED_AI_CLUSTER - UPDATE_DEDICATED_AI_CLUSTER - MOVE_DEDICATED_AI_CLUSTER - CREATE_ENDPOINT - DELETE_ENDPOINT - UPDATE_ENDPOINT - MOVE_ENDPOINT - CREATE_IMPORTED_MODEL - UPDATE_IMPORTED_MODEL - DELETE_IMPORTED_MODEL - CREATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - MOVE_PRIVATE_ENDPOINT - CREATE_VECTOR_STORE_CONNECTOR - UPDATE_VECTOR_STORE_CONNECTOR - DELETE_VECTOR_STORE_CONNECTOR - SCHEDULE_FILE_SYNC - TRIGGER_FILE_SYNC - CREATE_SEMANTIC_STORE - DELETE_SEMANTIC_STORE - MOVE_SEMANTIC_STORE - CREATE_APPLICATION_DEPLOYMENT - UPDATE_APPLICATION_DEPLOYMENT - DELETE_APPLICATION_DEPLOYMENT - MOVE_APPLICATION_DEPLOYMENT - CREATE_HOSTED_DEPLOYMENT - UPDATE_HOSTED_DEPLOYMENT - MOVE_HOSTED_DEPLOYMENT - DELETE_HOSTED_DEPLOYMENT - START_LOGGING - STOP_LOGGING - CREATE_APPLICATION_STORAGE - UPDATE_APPLICATION_STORAGE - MOVE_APPLICATION_STORAGE - DELETE_APPLICATION_STORAGE 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 - 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 required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted UpdateImportedModelDetails: description: 'The data to update an imported model. ' 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 imported model. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. 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 vendor: description: The provider of the imported model. maxLength: 255 minLength: 1 type: string version: description: The version of the imported model. maxLength: 255 minLength: 1 type: string type: object GenerativeAiProject: description: "A GenerativeAiProject is a logical container that stores conversation, file and containers. \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 who gives OCI resource access to users. See\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm).\n" properties: compartmentId: description: Owning compartment OCID for a GenerativeAiProject. type: string conversationConfig: $ref: '#/components/schemas/ConversationConfig' 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 GenerativeAiProject. type: string displayName: description: A user-friendly name. 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: An OCID that uniquely identifies a GenerativeAiProject. type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: The lifecycle state of a GenerativeAiProject. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string longTermMemoryConfig: $ref: '#/components/schemas/LongTermMemoryConfig' shortTermMemoryOptimizationConfig: $ref: '#/components/schemas/ShortTermMemoryOptimizationConfig' 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 that the generativeAiProject was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the generativeAiProject was updated in the format of an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - freeformTags - definedTags type: object ChangeGenerativeAiPrivateEndpointCompartmentDetails: description: 'The details required to change a private endpoint compartment. ' properties: compartmentId: description: 'The OCID of the target compartment where the private endpoint is moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object KeyDetails: description: The data to create/renew an API key item. properties: keyName: description: The key to renew. type: string timeExpiry: description: The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339. format: date-time type: string required: - keyName - timeExpiry type: object LongTermMemoryConfig: description: Configuration settings for long-term memory behavior. properties: standardLongTermMemoryStrategy: $ref: '#/components/schemas/StandardLongTermMemoryStrategy' type: object InboundAuthConfig: description: 'The client-side inbound authentication configuration for the Hosted Application. Defines the network access rules. When unspecified, the service applies the default inbound authentication configuration type. ' properties: idcsConfig: $ref: '#/components/schemas/IdcsAuthConfig' inboundAuthConfigType: description: 'Inbound authentication configuration type of network access (IDCS_AUTH_CONFIG). ' enum: - IDCS_AUTH_CONFIG type: string required: - inboundAuthConfigType type: object DedicatedAiClusterCollection: description: Results of a dedicate AI cluster search. Contains DedicatedAiClusterSummary items and other information such as metadata. properties: items: description: List of dedicated AI clusters. items: $ref: '#/components/schemas/DedicatedAiClusterSummary' type: array required: - items type: object SetApiKeyStateDetails: description: The data to set the state of an API key item. 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 keyName: description: The key to set state. type: string state: description: The target state of the API key item. type: string x-obmcs-enumref: '#/definitions/ApiKeyItem/state' required: - keyName - state type: object HostedApplicationIam: allOf: - $ref: '#/components/schemas/HostedApplicationBase' description: 'Hosted Application IAM, defines shared configurations that apply across multiple deployments of the Agent or MCP application. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm). ' UpdateSemanticStoreDetails: description: The data to update a SemanticStore. 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 SemanticStore. maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: A user-friendly name. maxLength: 255 minLength: 1 type: string x-default-description: 'null' 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 refreshSchedule: $ref: '#/components/schemas/RefreshScheduleDetails' schemas: $ref: '#/components/schemas/CreateSchemasDetails' type: object ApiKeyCollection: description: Results of a ApiKey search. properties: items: description: List of apiKeys. items: $ref: '#/components/schemas/ApiKeySummary' type: array required: - items type: object ScheduleConfig: description: The Schedule configuration of a VectorStoreConnector to trigger a File Sync Operation. discriminator: propertyName: configType properties: configType: description: The schedule config type enum: - INTERVAL - CRON type: string state: default: ENABLED description: The state of the schedule. The state can be either ENABLED or DISABLED. enum: - ENABLED - DISABLED type: string timeEnd: description: 'The schedule end date time, if null, the schedule will never expire. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' example: '2022-07-21T16:11:29Z' format: date-time type: string timeStart: description: 'The schedule starting date time, if null, System set the time when schedule is created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' example: '2022-07-21T16:11:29Z' format: date-time type: string required: - configType type: object ShortTermMemoryOptimizationConfig: description: Configuration settings for short-term memory optimization. properties: condenserConfig: $ref: '#/components/schemas/CondenserConfig' isEnabled: description: Indicates whether short-term memory optimization is enabled. type: boolean required: - isEnabled type: object ChangeApiKeyCompartmentDetails: description: The details to move an APIKey to another compartment. properties: compartmentId: description: The OCID of the compartment to move the APIKey to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object FileSyncStatistics: description: Synchronization Statistics for a VectorStore File Sync operation or for a VectorStore Connector properties: syncStatsByFileType: additionalProperties: maxProperties: 50 type: integer description: FileSync Statistics for different file types. type: object totalFilesSynced: description: The total number of files synchronized from the datasource. type: integer type: object OutboundNetworkingConfig: description: Outbound Networking configuration. properties: customSubnetId: description: ocid of customer subnet when networkMode=Custom type: string networkMode: description: outbounding to managed internet or customer network. enum: - MANAGED - CUSTOM type: string nsgIds: description: 'A list of the OCIDs of the network security groups that the private endpoint''s VNIC belongs to. ' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true required: - networkMode type: object HostedApplicationCollection: description: Results of a dedicate hosted application search. Contains HostedApplicationSummary items and other information such as metadata. properties: items: description: List of hosted applications. items: $ref: '#/components/schemas/HostedApplicationSummary' type: array required: - items type: object UpdateHostedDeploymentDetails: description: The data to update a hosted deployment. properties: activeArtifact: $ref: '#/components/schemas/SingleDockerArtifact' 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 required: - activeArtifact type: object PromptInjectionConfig: description: The configuration details for prompt injection (PI) detection. This is for input only. properties: isEnabled: description: Whether to enable the prompt injection feature. type: boolean mode: default: INFORM description: The mode of operation for prompt injection detection. type: string x-obmcs-enumref: '#/definitions/ContentModerationConfig/mode' modelId: description: The OCID of the model used for the feature. type: string required: - isEnabled type: object VectorStoreConnectorIngestionLogsCollection: description: Results of a VectorStoreConnector Ingestion Log search. properties: items: description: List of VectorStoreConnectorIngestionLogs objects. items: $ref: '#/components/schemas/VectorStoreConnectorIngestionLogs' type: array required: - items type: object CreateVectorStoreConnectorDetails: description: The data to create a VectorStoreConnector. properties: compartmentId: description: Owning compartment OCID for a ConversationStore. maxLength: 255 minLength: 1 type: string configuration: $ref: '#/components/schemas/ConnectorConfiguration' 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 VectorStoreConnector. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: A user-friendly name for the VectorStoreConnector. maxLength: 255 minLength: 1 type: string x-default-description: 'null' 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 scheduleConfig: $ref: '#/components/schemas/ScheduleConfig' vaultSecretId: description: An optional customer Encryption Key stored in OCI Vault that can be used to decrypt the data downloaded from the data source. type: string vectorStoreId: description: An OCID that identifies the Vector Store to which this connector is connected. maxLength: 255 minLength: 1 type: string required: - compartmentId - vectorStoreId - displayName - configuration type: object NetworkingConfig: description: Networking configuration. properties: inboundNetworkingConfig: $ref: '#/components/schemas/InboundNetworkingConfig' outboundNetworkingConfig: $ref: '#/components/schemas/OutboundNetworkingConfig' required: - inboundNetworkingConfig - outboundNetworkingConfig type: object RefreshScheduleDetails: description: Specifies a refresh schedule. Null represents no automated synchronization schedule. discriminator: propertyName: type properties: type: description: "Specifies the type of refresh schedule. \n" enum: - INTERVAL - ON_CREATE - NONE type: string required: - type type: object ImportedModel: description: 'Represents a model imported into the system based on an external data source, such as Hugging Face or Object Storage. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm). ' properties: capabilities: description: Specifies the intended use or supported capabilities of the imported model. items: enum: - TEXT_TO_TEXT - IMAGE_TEXT_TO_TEXT - EMBEDDING - RERANK type: string x-obmcs-top-level-enum: '#/definitions/ImportedModelCapability' type: array compartmentId: description: The compartment OCID from which the model is imported. maxLength: 255 minLength: 1 type: string dataSource: $ref: '#/components/schemas/ModelDataSource' 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 imported model. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. 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: An OCID that uniquely identifies an imported model. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current state of the imported model, providing more detailed and actionable context. maxLength: 255 minLength: 1 type: string lifecycleState: description: The lifecycle state of the imported model. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string previousState: $ref: '#/components/schemas/ImportedModel' 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 that the imported model was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the imported model was updated in the format of an RFC3339 datetime string. format: date-time type: string vendor: description: The provider of the imported model. maxLength: 255 minLength: 1 type: string version: description: The version of the imported model. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - timeCreated - lifecycleState - dataSource type: object ChangeHostedApplicationCompartmentDetails: description: The details to move a hosted application to another compartment. properties: compartmentId: description: The OCID of the compartment to move the hosted application to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object FileSyncIngestionLogsCollection: description: Results of a VectorStoreConnector Ingestion Log search. properties: items: description: List of VectorStoreConnectorIngestionLogs objects. items: $ref: '#/components/schemas/FileSyncIngestionLogs' type: array required: - items type: object ApiKeySummary: description: Summary of the API key. properties: compartmentId: description: The compartment OCID to create the apiKey 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 Api key. maxLength: 400 minLength: 1 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 ApiKey id. maxLength: 255 minLength: 1 type: string keys: description: The list of keys. items: $ref: '#/components/schemas/ApiKeyItem' maxItems: 2 type: array lifecycleDetails: description: A message describing the current state with detail that can provide actionable information. type: string lifecycleState: description: 'The current state of the API key. Allowed values are: - ACTIVE - INACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/ApiKey/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 that the ApiKey was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time the ApiKey was updated, in the format defined by RFC 3339. format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - keys type: object CreateHostedDeploymentDetails: description: The data to create a hosted deployment. Exactly one of hostedApplicationId or hostedApplicationIamId must be provided. properties: activeArtifact: $ref: '#/components/schemas/Artifact' compartmentId: description: The compartment OCID to create the hosted deployment 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 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 hostedApplicationId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HostedApplication parent. type: string required: - activeArtifact type: object ScalingConfig: description: 'The auto scaling configuration for the Hosted Application. Defines the minimum and maximum number of replicas. When unspecified, the service applies service-defined default scaling values. ' properties: maxReplica: default: 3 description: Maximum number of replicas allowed. maximum: 50 minimum: 0 type: integer minReplica: default: 1 description: Minimum number of replicas to keep running. maximum: 50 minimum: 0 type: integer scalingType: default: REQUESTS_PER_SECOND description: scaling type for application. enum: - CPU - MEMORY - CONCURRENCY - REQUESTS_PER_SECOND type: string targetConcurrencyThreshold: default: 50 description: number of simultaneous requests that can be processed by each replica. maximum: 500 minimum: 1 type: integer targetCpuThreshold: default: 70 description: Scale up if average CPU utilization exceeds this threshold. maximum: 95 minimum: 50 type: integer targetMemoryThreshold: default: 80 description: Scale up if average memory utilization exceeds this threshold. maximum: 95 minimum: 50 type: integer targetRpsThreshold: default: 50 description: requests-per-second per replica of an application. maximum: 500 minimum: 5 type: integer required: - scalingType type: object DedicatedAiCluster: description: 'Dedicated AI clusters are compute resources that you can use for fine-tuning custom models or for hosting endpoints for custom models. The clusters are dedicated to your models and not shared with users in other tenancies. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm). ' properties: capacity: $ref: '#/components/schemas/DedicatedAiClusterCapacity' compartmentId: description: The compartment OCID to create the dedicated AI cluster in. 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 dedicated AI cluster. 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 dedicated AI cluster. type: string lifecycleDetails: description: A message describing the current state with detail that can provide actionable information. type: string lifecycleState: description: The current state of the dedicated AI cluster. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string previousState: $ref: '#/components/schemas/DedicatedAiCluster' 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 dedicated AI cluster was created, in the format defined by RFC 3339 format: date-time type: string timeUpdated: description: The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339 format: date-time type: string type: description: The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor. enum: - HOSTING - FINE_TUNING type: string unitCount: description: The number of dedicated units in this AI cluster. type: integer unitShape: description: The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers. enum: - LARGE_COHERE - LARGE_COHERE_V2 - SMALL_COHERE - SMALL_COHERE_V2 - SMALL_COHERE_4 - EMBED_COHERE - LLAMA2_70 - LARGE_GENERIC - LARGE_COHERE_V2_2 - LARGE_GENERIC_4 - SMALL_GENERIC_V2 - LARGE_GENERIC_2 - LARGE_GENERIC_V2 - LARGE_GENERIC_V3 - COHERE_H100_X1 - COHERE_A100_80G_X1 - COHERE_A100_40G_X1 - COHERE_A10_X1 - LARGE_COHERE_V3 - RERANK_COHERE - SMALL_GENERIC_V1 - MEDIUM_GENERIC_V1 - LARGE_GENERIC_V1 - A10_X1 - A10_X2 - A10_X4 - A100_40G_X1 - A100_40G_X2 - A100_40G_X4 - A100_40G_X8 - A100_80G_X1 - A100_80G_X2 - A100_80G_X4 - A100_80G_X8 - H100_X1 - H100_X2 - H100_X4 - H100_X8 - H200_X1 - H200_X2 - H200_X4 - H200_X8 - OAI_A10_X2 - OAI_H100_X1 - OAI_H100_X2 - OAI_H200_X1 - OAI_A100_80G_X1 - OAI_A100_80G_X2 - OAI_A100_40G_X1 - OAI_A100_40G_X4 type: string required: - id - type - compartmentId - lifecycleState - timeCreated - unitCount - unitShape type: object HostedDeploymentCollection: description: Results of a dedicate hosted deployment search. Contains Hosted Deployment Summary items and other information such as metadata. properties: items: description: List of hosted deployments. items: $ref: '#/components/schemas/HostedDeploymentSummary' type: array required: - items type: object InboundNetworkingConfig: description: Inbound Networking configuration. properties: endpointMode: description: inbounding from public or private endpoint. enum: - PUBLIC - PRIVATE type: string privateEndpointId: description: The [OCID] of Private Endpoint when endpointMode=Private type: string required: - endpointMode type: object UpdateVectorStoreConnectorDetails: description: The data to update a VectorStoreConnector. properties: configuration: $ref: '#/components/schemas/ConnectorConfiguration' 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 VectorStoreConnector. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: A user-friendly name for the VectorStoreConnector. maxLength: 255 minLength: 1 type: string x-default-description: 'null' 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 scheduleConfig: $ref: '#/components/schemas/ScheduleConfig' type: object UpdateApiKeyDetails: description: The data to update an API key. 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 Api key. maxLength: 400 minLength: 1 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 type: object SemanticStore: description: 'A Semantic Store is a container resource of semantic records, with controllable enrichment refresh and synchronization policy. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm). ' properties: compartmentId: description: Owning compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) for a SemanticStore. type: string dataSource: $ref: '#/components/schemas/DataSourceDetails' 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 SemanticStore. type: string displayName: description: A user-friendly name. 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: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) that uniquely identifies a SemanticStore. type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: The lifecycle state of a SemanticStore. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string refreshSchedule: $ref: '#/components/schemas/RefreshScheduleDetails' schemas: $ref: '#/components/schemas/SchemasDetails' 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 that the SemanticStore was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - timeUpdated - dataSource - schemas - freeformTags - definedTags - systemTags type: object HostedDeployment: description: 'Hosted deployment is designed to support the full spectrum of agent use cases from lightweight, employee-facing assistants and internal workflow automation, to enterprise-grade, large-scale customer-facing workloads. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm). ' properties: activeArtifact: $ref: '#/components/schemas/Artifact' artifacts: description: array of Artifacts. items: $ref: '#/components/schemas/Artifact' type: array compartmentId: description: The compartment OCID to create the hosted application in. 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 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 hostedApplicationId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HostedApplication parent. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. type: string lifecycleState: description: The current state of the hosted deployment. enum: - CREATING - NEEDS_ATTENTION - ACTIVE - INACTIVE - UPDATING - 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 hosted deployment was created, in the format defined by RFC 3339 format: date-time type: string timeUpdated: description: The date and time the hosted deployment was updated, in the format defined by RFC 3339 format: date-time type: string required: - id - lifecycleState - activeArtifact - artifacts type: object ModelDataSource: description: "Defines the source location and method used to import the model. Supports importing from Hugging Face, \nan Object Storage location, or by referencing an already imported model.\n" discriminator: propertyName: sourceType properties: sourceType: description: Specifies the source type for model import. enum: - HUGGING_FACE_MODEL - OBJECT_STORAGE_OBJECT type: string type: object WorkRequestLogEntry: description: The log message from performing an operation that is tracked by this 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 Dataset: description: "The dataset used to fine-tune the model. \n\nOnly one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the dataset in a JSON Lines (JSONL) file. Each line in the JSONL file must have the format:\n \n`{\"prompt\": \"\", \"completion\": \"\"}`\n" discriminator: propertyName: datasetType properties: datasetType: description: The type of the data asset. enum: - OBJECT_STORAGE type: string required: - datasetType EndpointCollection: description: Results of an endpoint search. Contains EndpointSummary items and other information such as metadata. properties: items: description: List of endpoints. items: $ref: '#/components/schemas/EndpointSummary' type: array required: - items type: object WorkRequest: description: "An asynchronous work request. When you start a long-running operation, the service creates a work request. Work requests help you monitor long-running operations. \n\nA 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.\n" 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_MODEL - DELETE_MODEL - MOVE_MODEL - CREATE_DEDICATED_AI_CLUSTER - DELETE_DEDICATED_AI_CLUSTER - UPDATE_DEDICATED_AI_CLUSTER - MOVE_DEDICATED_AI_CLUSTER - CREATE_ENDPOINT - DELETE_ENDPOINT - UPDATE_ENDPOINT - MOVE_ENDPOINT - CREATE_IMPORTED_MODEL - UPDATE_IMPORTED_MODEL - DELETE_IMPORTED_MODEL - CREATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - MOVE_PRIVATE_ENDPOINT - CREATE_VECTOR_STORE_CONNECTOR - UPDATE_VECTOR_STORE_CONNECTOR - DELETE_VECTOR_STORE_CONNECTOR - SCHEDULE_FILE_SYNC - TRIGGER_FILE_SYNC - CREATE_SEMANTIC_STORE - DELETE_SEMANTIC_STORE - MOVE_SEMANTIC_STORE - CREATE_APPLICATION_DEPLOYMENT - UPDATE_APPLICATION_DEPLOYMENT - DELETE_APPLICATION_DEPLOYMENT - MOVE_APPLICATION_DEPLOYMENT - CREATE_HOSTED_DEPLOYMENT - UPDATE_HOSTED_DEPLOYMENT - MOVE_HOSTED_DEPLOYMENT - DELETE_HOSTED_DEPLOYMENT - START_LOGGING - STOP_LOGGING - CREATE_APPLICATION_STORAGE - UPDATE_APPLICATION_STORAGE - MOVE_APPLICATION_STORAGE - DELETE_APPLICATION_STORAGE 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 - 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 required: - id - compartmentId - operationType - status - resources - percentComplete - timeAccepted TrainingConfig: description: The fine-tuning method and hyperparameters used for fine-tuning a custom model. discriminator: propertyName: trainingConfigType properties: earlyStoppingPatience: description: 'Stop training if the loss metric does not improve beyond ''early_stopping_threshold'' for this many times of evaluation. ' type: integer earlyStoppingThreshold: description: How much the loss must improve to prevent early stopping. format: double type: number learningRate: description: The initial learning rate to be used during training format: double type: number logModelMetricsIntervalInSteps: description: "Determines how frequently to log model metrics. \n\nEvery step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.\n" type: integer totalTrainingEpochs: description: The maximum number of training epochs to run for. type: integer trainingBatchSize: description: The batch size used during training. type: integer trainingConfigType: default: TFEW_TRAINING_CONFIG description: The fine-tuning method for training a custom model. enum: - TFEW_TRAINING_CONFIG - VANILLA_TRAINING_CONFIG - LORA_TRAINING_CONFIG type: string required: - trainingConfigType CreateApiKeyDetails: description: The data to create an API key. properties: compartmentId: description: The compartment OCID to create the apiKey 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 Api key. maxLength: 400 minLength: 1 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 keyDetails: description: The list of key details for creation. items: $ref: '#/components/schemas/KeyDetails' maxItems: 2 type: array required: - displayName - compartmentId - keyDetails type: object DedicatedAiClusterSummary: description: Summary information about a dedicated AI cluster. properties: capacity: $ref: '#/components/schemas/DedicatedAiClusterCapacity' compartmentId: description: The compartment OCID to create the dedicated AI cluster in. 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 dedicated AI cluster. 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 dedicated AI cluster. type: string lifecycleDetails: description: A message describing the current state of the dedicated AI cluster in more detail that can provide actionable information. type: string lifecycleState: description: 'The current state of the dedicated AI cluster. Allowed values are: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION ' type: string x-obmcs-enumref: '#/definitions/DedicatedAiCluster/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 dedicated AI cluster was created, in the format defined by RFC 3339. format: date-time type: string timeUpdated: description: The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339. format: date-time type: string type: description: 'The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor. Allowed values are: - HOSTING - FINE_TUNING ' type: string x-obmcs-enumref: '#/definitions/DedicatedAiCluster/type' unitCount: description: The number of dedicated units in this AI cluster. type: integer unitShape: description: The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers. type: string x-obmcs-enumref: '#/definitions/DedicatedAiCluster/unitShape' required: - id - type - compartmentId - lifecycleState - timeCreated - unitCount - unitShape type: object LlmSelection: description: LLM selection configuration. discriminator: propertyName: llmSelectionType properties: llmSelectionType: description: The type of LLM selection. enum: - GEN_AI_MODEL type: string required: - llmSelectionType type: object SemanticStoreCollection: description: Results of a SemanticStore list. Contains SemanticStoreSummary items and other information such as metadata. properties: items: description: List of SemanticStores. items: $ref: '#/components/schemas/SemanticStoreSummary' type: array required: - items type: object ImportedModelCollection: description: 'Represents the result of a list operation for imported models. ' properties: items: description: Represents the result of a list operation for imported models. items: $ref: '#/components/schemas/ImportedModelSummary' type: array required: - items type: object EndpointSummary: description: Summary information for an endpoint resource. properties: compartmentId: description: The compartment OCID to create the endpoint in. type: string contentModerationConfig: $ref: '#/components/schemas/ContentModerationConfig' dedicatedAiClusterId: description: The OCID of the dedicated AI cluster on which a model will be deployed to. 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 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 generativeAiPrivateEndpointId: description: The OCID of the Generative AI private endpoint to which this endpoint is attached to. maxLength: 255 minLength: 1 type: string id: description: An OCID that uniquely identifies this endpoint resource. type: string lifecycleDetails: description: A message describing the current state with detail that can provide actionable information. type: string lifecycleState: description: 'The current state of the endpoint. Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/Endpoint/lifecycleState' modelId: description: The OCID of the model that's used to create this endpoint. type: string piiDetectionConfig: $ref: '#/components/schemas/PiiDetectionConfig' promptInjectionConfig: $ref: '#/components/schemas/PromptInjectionConfig' 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 that the endpoint was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time the endpoint was updated in the format of n RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - modelId - dedicatedAiClusterId type: object CondenserConfig: allOf: - $ref: '#/components/schemas/ModelConfig' - discriminator: CONDENSER type: object description: Configuration for condensing conversation content. type: object Endpoint: description: "To host a custom model for inference, create an endpoint for that model on a dedicated AI cluster of type HOSTING. \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 who gives OCI resource access to users. See\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm).\n" properties: compartmentId: description: The compartment OCID to create the endpoint in. type: string contentModerationConfig: $ref: '#/components/schemas/ContentModerationConfig' dedicatedAiClusterId: description: The OCID of the dedicated AI cluster on which the model will be deployed to. 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 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 generativeAiPrivateEndpointId: description: The OCID of the Generative AI private endpoint to which this endpoint is attached to. maxLength: 255 minLength: 1 type: string id: description: An OCID that uniquely identifies this endpoint resource. type: string lifecycleDetails: description: A message describing the current state of the endpoint in more detail that can provide actionable information. type: string lifecycleState: description: The current state of the endpoint. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string modelId: description: The OCID of the model that's used to create this endpoint. type: string piiDetectionConfig: $ref: '#/components/schemas/PiiDetectionConfig' previousState: $ref: '#/components/schemas/Endpoint' promptInjectionConfig: $ref: '#/components/schemas/PromptInjectionConfig' 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 that the endpoint was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the endpoint was updated in the format of an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - modelId - dedicatedAiClusterId type: object HostedApplicationStorageSummary: description: Summary information about a hosted application storage. properties: compartmentId: description: The compartment OCID to create the hosted application in. 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 hosted application. 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 hosted application. type: string lifecycleState: description: The current state of the hosted application storage. type: string x-obmcs-enumref: '#/definitions/HostedApplicationStorage/lifecycleState' storageType: description: type like Cache, Postgresql and ADB. enum: - CACHE - POSTGRESQL - ADB 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 hosted application was created, in the format defined by RFC 3339. format: date-time type: string timeUpdated: description: The date and time the hosted application was updated, in the format defined by RFC 3339. format: date-time type: string required: - id - lifecycleState - displayName type: object CreateModelDetails: description: The data to create a custom model. properties: baseModelId: description: The OCID of the base model that's used for fine-tuning. type: string compartmentId: description: The compartment OCID for fine-tuned models. For pretrained models, this value is null. 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 model. type: string displayName: description: A user-friendly name. maxLength: 255 minLength: 1 type: string fineTuneDetails: $ref: '#/components/schemas/FineTuneDetails' 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 vendor: description: The provider of the model. type: string version: description: The version of the model. type: string required: - compartmentId - baseModelId - fineTuneDetails type: object ChangeEndpointCompartmentDetails: description: The details to move an endpoint to another compartment. properties: compartmentId: description: The OCID of the compartment to move the endpoint to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object WorkRequestResource: description: The 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 DataSourceDetails: description: Defines the data source that the semantic model connects to. discriminator: propertyName: connectionType properties: connectionType: description: Specifies the type of underlying connection. enum: - DATABASE_TOOLS_CONNECTION type: string required: - connectionType type: object UpdateModelDetails: description: 'The data to update a custom model. ' 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 model. type: string displayName: description: A user-friendly name. 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 vendor: description: The provider of the base model. type: string version: description: The version of the model. type: string type: object SingleDockerArtifact: allOf: - $ref: '#/components/schemas/Artifact' - discriminator: propertyName: SIMPLE_DOCKER_ARTIFACT properties: containerUri: description: image url. type: string tag: description: image tag. type: string description: Container/artifact configuration for the deployment. UpdateEndpointDetails: 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 endpoint. maxLength: 400 minLength: 1 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 generativeAiPrivateEndpointId: description: The OCID of the Generative AI private endpoint to which this endpoint will be attached. maxLength: 255 minLength: 0 type: string piiDetectionConfig: $ref: '#/components/schemas/PiiDetectionConfig' promptInjectionConfig: $ref: '#/components/schemas/PromptInjectionConfig' type: object ApiKey: description: "ApiKeys are resources used to access GenAI models. \nYou must be authorized through an IAM policy to use any API operations. If you're not authorized, contact an administrator who manages OCI resource access. See\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm).\n" properties: compartmentId: description: The compartment OCID to create the apiKey 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 Api key. maxLength: 400 minLength: 1 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 ApiKey id. maxLength: 255 minLength: 1 type: string keys: description: The list of keys. items: $ref: '#/components/schemas/ApiKeyItem' maxItems: 2 type: array lifecycleDetails: description: A message describing the current state with detail that can provide actionable information. type: string lifecycleState: description: The current state of the API key. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - 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 that the ApiKey was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time the ApiKey was updated, in the format defined by RFC 3339. format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - keys type: object CreateSemanticStoreDetails: description: The data to create a SemanticStore. properties: compartmentId: description: Owning compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) for a SemanticStore. maxLength: 255 minLength: 1 type: string dataSource: $ref: '#/components/schemas/CreateDataSourceDetails' 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 SemanticStore. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: A user-friendly name. maxLength: 255 minLength: 1 type: string x-default-description: 'null' 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 refreshSchedule: $ref: '#/components/schemas/RefreshScheduleDetails' schemas: $ref: '#/components/schemas/CreateSchemasDetails' required: - compartmentId - displayName - dataSource - schemas type: object CreateDataSourceDetails: description: Defines the data source that the semantic model connects to. discriminator: propertyName: connectionType properties: connectionType: description: Specifies the type of underlying connection. enum: - DATABASE_TOOLS_CONNECTION type: string required: - connectionType type: object VectorStoreConnectorFileSyncSummary: description: Summary information for a VectorStoreConnectorFileSync properties: compartmentId: description: Owning compartment OCID for a VectorStoreConnectorFileSync. 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 displayName: description: A user-friendly name. type: string durationInSeconds: description: The duration (in seconds) taken for the VectorStoreConnectorFileSync operation to complete. type: integer 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: An OCID that uniquely identifies a VectorStoreConnectorFileSync operation. type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: "The current state of the VectorStoreConnectorFileSync operation.\nAccepted Values are:\n - ACCEPTED\n - IN_PROGRESS\n - FAILED\n - SUCCEEDED\n - CANCELING\n - CANCELED\n" type: string x-obmcs-enumref: '#/definitions/VectorStoreConnectorFileSync/lifecycleState' stats: $ref: '#/components/schemas/VectorStoreConnectorStats' 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 tenantId: description: Owning tenant OCID for a VectorStoreConnector type: string timeCreated: description: The date and time that the FileSync operation was created in the format of an RFC3339 datetime string. format: date-time type: string timeEnded: description: The date and time when the FileSync operation has ended in the format of an RFC3339 datetime string. format: date-time type: string timeStarted: description: The date and time when the FileSync operation has started in the format of an RFC3339 datetime string. format: date-time type: string triggerType: description: The type of the FileSync operation based on how it is triggered. The type can be either MANUAL or SCHEDULED enum: - MANUAL - SCHEDULED type: string vectorStoreConnectorId: description: An OCID that identifies the VectorStoreConnector under which this FileSync operation is created. type: string required: - id - vectorStoreConnectorId - compartmentId - tenantId - displayName - lifecycleState - timeCreated - triggerType - freeformTags - definedTags - systemTags type: object WorkRequestError: description: An error encountered while performing an operation that is tracked by this 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 that 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 EnvironmentVariable: description: The environment variables for the Hosted Application properties: name: description: Name of the environment variable. maxLength: 255 minLength: 1 type: string type: description: Type of the environment variable (PLAINTEXT or HASHED, no default value). enum: - PLAINTEXT - VAULT type: string value: description: Value of the environment variable. maxLength: 400 minLength: 1 type: object required: - name - type - value type: object StorageConfig: description: The type of service-managed storage. properties: environmentVariableKey: description: The key of environment variable to store the database connection. type: string storageId: description: The [OCID] of ApplicationStorage. type: string required: - storageId - environmentVariableKey type: object UpdateDedicatedAiClusterDetails: description: The data to update a dedicated AI cluster. 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 dedicated AI cluster. maxLength: 400 minLength: 1 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 unitCount: description: The number of dedicated units in this AI cluster. minimum: 1 type: integer type: object ConversationConfig: description: Holds configuration related to conversation retention properties: conversationsRetentionInHours: default: 1 description: Retention period (in hours) for conversations. The TTL starts from the time the conversation was last updated. maximum: 720 minimum: 1 type: integer responsesRetentionInHours: default: 1 description: Retention period (in hours) for responses. The TTL starts from the time the response was created. maximum: 720 minimum: 1 type: integer type: object VectorStoreConnectorFileSyncCollection: description: Results of a VectorStoreConnectorFileSync search. properties: items: description: List of VectorStoreConnectorFileSync operations. items: $ref: '#/components/schemas/VectorStoreConnectorFileSyncSummary' type: array required: - items type: object SchemasDetails: description: Array of database schemas or other database objects to include in enrichment pipeline. discriminator: propertyName: connectionType properties: connectionType: description: Specifies the type of underlying connection. enum: - DATABASE_TOOLS_CONNECTION type: string required: - connectionType type: object CreateHostedApplicationBaseDetails: description: Common creation properties shared by HostedApplication and HostedApplicationIam. properties: compartmentId: description: The compartment OCID for the Hosted Application. 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: The description for the Hosted Application. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: 'The user-friendly display name for the Hosted Application. Does not need to be unique and can be updated after creation. ' maxLength: 255 minLength: 1 type: string environmentVariables: description: 'The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime. ' items: $ref: '#/components/schemas/EnvironmentVariable' maxItems: 1000 type: array 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 networkingConfig: $ref: '#/components/schemas/NetworkingConfig' scalingConfig: $ref: '#/components/schemas/ScalingConfig' storageConfigs: description: 'The list of storage configuration for the Hosted Application. Defines a list of service-managed storage back-ends. ' items: $ref: '#/components/schemas/StorageConfig' maxItems: 3 type: array required: - displayName - compartmentId type: object VectorStoreConnectorSummary: description: Summary information for a VectorStoreConnector properties: compartmentId: description: Owning compartment OCID for a VectorStoreConnector. type: string configuration: $ref: '#/components/schemas/ConnectorConfiguration' 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 VectorStoreConnector type: string displayName: description: A user-friendly name 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: An OCID that uniquely identifies a VectorStoreConnector type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: 'The lifecycle state of a VectorStoreConnector. Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/VectorStoreConnector/lifecycleState' scheduleConfig: $ref: '#/components/schemas/ScheduleConfig' 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 tenantId: description: Owning tenant OCID for a VectorStoreConnector type: string timeCreated: description: The date and time that the VectorStoreConnector was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the VectorStoreConnector was updated in the format of an RFC3339 datetime string. format: date-time type: string vectorStoreId: description: An OCID that identifies the Vector Store to which this connector is connected. type: string required: - id - displayName - vectorStoreId - compartmentId - lifecycleState - timeCreated - configuration - tenantId - freeformTags - definedTags - systemTags type: object GenerativeAiProjectCollection: description: Results of a GenerativeAiProject search. Contains GenerativeAiProjectSummary items and other information such as metadata. properties: items: description: List of GenerativeAiProjects. items: $ref: '#/components/schemas/GenerativeAiProjectSummary' type: array required: - items type: object UpdateGenerativeAiProjectDetails: description: The data to update a GenerativeAiProject. properties: conversationConfig: $ref: '#/components/schemas/ConversationConfig' 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 GenerativeAiProject. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: A user-friendly name. maxLength: 255 minLength: 1 type: string x-default-description: 'null' 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 longTermMemoryConfig: $ref: '#/components/schemas/LongTermMemoryConfig' shortTermMemoryOptimizationConfig: $ref: '#/components/schemas/ShortTermMemoryOptimizationConfig' type: object CreateArtifactDetails: description: Artifact configuration input for the deployment. discriminator: propertyName: artifactType properties: artifactType: description: The type of the artifact. enum: - SIMPLE_DOCKER_ARTIFACT type: string isVulnerabilityScanRequired: default: false description: 'Optional flag that requires an OCI Vulnerability Scanning Service compliance report for this artifact before it can become active. When omitted, the value defaults to false. ' type: boolean type: object VectorStoreConnector: description: "A VectorStore Connector offers a lightweight and configurable mechanism to continuously synchronize data \nfrom external systems into the VectorStore at scale. It captures the configuration of the datasource for data\ningestion.\n" properties: compartmentId: description: Owning compartment OCID for a VectorStoreConnector. type: string configuration: $ref: '#/components/schemas/ConnectorConfiguration' 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 VectorStoreConnector type: string displayName: description: A user-friendly name 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: An OCID that uniquely identifies a VectorStoreConnector type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: The lifecycle state of a VectorStoreConnector. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string scheduleConfig: $ref: '#/components/schemas/ScheduleConfig' 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 tenantId: description: Owning tenant OCID for a VectorStoreConnector type: string timeCreated: description: The date and time that the VectorStoreConnector was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the VectorStoreConnector was updated in the format of an RFC3339 datetime string. format: date-time type: string vaultSecretId: description: An optional customer Encryption Key stored in OCI Vault that can be used to decrypt the data downloaded from the data source. type: string vectorStoreId: description: An OCID that identifies the Vector Store to which this connector is connected. type: string required: - id - displayName - vectorStoreId - compartmentId - lifecycleState - timeCreated - configuration - tenantId - freeformTags - definedTags - systemTags type: object HostedApplicationBase: description: Common properties shared by HostedApplication and HostedApplicationIam. properties: compartmentId: description: The compartment OCID to create the hosted application in. 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 hosted application. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string environmentVariables: description: 'The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime. ' items: $ref: '#/components/schemas/EnvironmentVariable' maxItems: 1000 type: array 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 hosted application. type: string lifecycleDetails: description: A message describing the current state of the endpoint in more detail that can provide actionable information. type: string lifecycleState: description: The current state of the hosted application. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string networkingConfig: $ref: '#/components/schemas/NetworkingConfig' scalingConfig: $ref: '#/components/schemas/ScalingConfig' storageConfigs: description: A list of storageConfigs managed by the OCI GenAI Platform and attached to the application. items: $ref: '#/components/schemas/StorageConfig' maxItems: 3 type: array 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 hosted application was created, in the format defined by RFC 3339 format: date-time type: string timeUpdated: description: The date and time the hosted application was updated, in the format defined by RFC 3339 format: date-time type: string required: - id - displayName - lifecycleState type: object HostedApplicationSummary: description: Summary information about a hosted application. properties: compartmentId: description: The compartment OCID to create the hosted application in. 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 hosted application. 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 hosted application. type: string lifecycleState: description: The current state of the hosted application. type: string x-obmcs-enumref: '#/definitions/HostedApplicationBase/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 hosted application was created, in the format defined by RFC 3339. format: date-time type: string timeUpdated: description: The date and time the hosted application was updated, in the format defined by RFC 3339. format: date-time type: string required: - id - lifecycleState - displayName type: object VectorStoreConnectorFileSync: description: "The VectorStoreConnectorFileSync is an operation that carries out the data sync operation between the datasource \nand the VectorStore. The FileSync can be triggered either manually or at a scheduled interval by the \nVectorStoreConnector.\n" properties: compartmentId: description: Owning compartment OCID for a VectorStoreConnectorFileSync. 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 displayName: description: A user-friendly name. type: string durationInSeconds: description: The total time taken (in seconds) for the VectorStoreConnectorFileSync operation. type: integer 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: An OCID that uniquely identifies a VectorStoreConnectorFileSync operation. type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: The current state of the VectorStoreConnectorFileSync operation. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string stats: $ref: '#/components/schemas/VectorStoreConnectorStats' 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 tenantId: description: Owning tenant OCID for a VectorStoreConnector type: string timeCreated: description: The date and time that the FileSync operation was created in the format of an RFC3339 datetime string. format: date-time type: string timeEnded: description: The date and time when the FileSync operation has ended in the format of an RFC3339 datetime string. format: date-time type: string timeStarted: description: The date and time when the FileSync operation has started in the format of an RFC3339 datetime string. format: date-time type: string triggerType: description: The type of the FileSync operation based on how it is triggered. The type can be either MANUAL or SCHEDULED enum: - MANUAL - SCHEDULED type: string vectorStoreConnectorId: description: An OCID that identifies the VectorStoreConnector under which this FileSync operation is created. type: string required: - id - vectorStoreConnectorId - compartmentId - tenantId - displayName - lifecycleState - timeCreated - triggerType - freeformTags - definedTags - systemTags type: object VectorStoreConnectorStats: description: File synchronization statistics for a VectorStoreConnector. properties: created: $ref: '#/components/schemas/FileSyncStatistics' 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 deleted: $ref: '#/components/schemas/FileSyncStatistics' failed: $ref: '#/components/schemas/FileSyncStatistics' 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 ignored: $ref: '#/components/schemas/FileSyncStatistics' inProgress: $ref: '#/components/schemas/FileSyncStatistics' metadataUpdated: $ref: '#/components/schemas/FileSyncStatistics' 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 timeGenerated: description: The date and time when the statistics was generated in the format of an RFC3339 datetime string. format: date-time type: string unsupported: $ref: '#/components/schemas/FileSyncStatistics' updated: $ref: '#/components/schemas/FileSyncStatistics' required: - timeGenerated type: object GenerativeAiPrivateEndpointCollection: description: 'Collection of GenerativeAiPrivateEndpointSummary ' properties: items: description: 'The results of a GenerativeAiPrivateEndpoint list. ' items: $ref: '#/components/schemas/GenerativeAiPrivateEndpointSummary' type: array required: - items type: object HostedApplicationStorageCollection: description: Results of a dedicate hosted application search. Contains HostedApplicationStorageSummary items and other information such as metadata. properties: items: description: List of hosted application storages. items: $ref: '#/components/schemas/HostedApplicationStorageSummary' type: array required: - items type: object CreateHostedApplicationStorageDetails: description: The data to create a hosted application storage. properties: compartmentId: description: The compartment OCID to create the hosted application 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 hosted application. maxLength: 400 minLength: 1 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 storageType: description: type like Cache, Postgresql and ADB. type: string x-obmcs-enumref: '#/definitions/HostedApplicationStorage/storageType' required: - displayName - compartmentId - storageType type: object ConnectorConfiguration: description: Datasource configuration for the connector. discriminator: propertyName: type properties: type: description: The type of the connector enum: - OBJECT_STORAGE_FILES type: string required: - type type: object ExtractionConfig: allOf: - $ref: '#/components/schemas/ModelConfig' - discriminator: EXTRACTION type: object description: Configuration for information extraction from conversation content. type: object SemanticStoreSummary: description: Summary information for a SemanticStore. properties: compartmentId: description: Owning compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) for a SemanticStore. type: string dataSource: $ref: '#/components/schemas/DataSourceDetails' 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 SemanticStore. 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: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) that uniquely identifies a SemanticStore. type: string lifecycleDetails: description: A message describing the current state in more detail that can provide actionable information. type: string lifecycleState: description: 'The current state of the SemanticStore. Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/SemanticStore/lifecycleState' refreshSchedule: $ref: '#/components/schemas/RefreshScheduleDetails' schemas: $ref: '#/components/schemas/SchemasDetails' 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 that the semanticStore was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the semanticStore was updated in the format of an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - timeUpdated - displayName - schemas - dataSource - freeformTags - definedTags - systemTags type: object HostedApplicationStorage: description: "defines a physical storage (database or cache) managed by service. Each application can choose one or two storages for certain purpose such as agent memory. \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 who gives OCI resource access to users. See\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm).\n" properties: applicationIds: description: A list of application OCID. items: maxLength: 255 minLength: 0 type: string type: array uniqueItems: true compartmentId: description: The compartment OCID to create the hosted application in. 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 hosted application storage. 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 hosted application storage. type: string lifecycleDetails: description: A message describing the current state of the hosted application storage in more detail that can provide actionable information. type: string lifecycleState: description: The current state of the hosted application storage. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string storageType: description: type like Cache, Postgresql and ADB. enum: - CACHE - POSTGRESQL - ADB 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 hosted application was created, in the format defined by RFC 3339 format: date-time type: string timeUpdated: description: The date and time the hosted application was updated, in the format defined by RFC 3339 format: date-time type: string required: - id - displayName - lifecycleState - compartmentId - storageType - applicationIds type: object RenewApiKeyDetails: description: The data to renew an API key item. 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 details: $ref: '#/components/schemas/KeyDetails' 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: - details type: object ImportedModelSummary: description: 'Summary of the importedModel. ' properties: capabilities: description: Specifies the intended use or supported capabilities of the imported model. items: enum: - TEXT_TO_TEXT - IMAGE_TEXT_TO_TEXT - EMBEDDING - RERANK type: string x-obmcs-top-level-enum: '#/definitions/ImportedModelCapability' type: array compartmentId: description: The compartment OCID from which the model is imported. maxLength: 255 minLength: 1 type: string dataSource: $ref: '#/components/schemas/ModelDataSource' 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 imported model. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name of the imported model. 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: An OCID that uniquely identifies an imported model. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current state of the imported model, providing more detailed and actionable context. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The lifecycle state of the imported model. Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED ' type: string x-obmcs-enumref: '#/definitions/ImportedModel/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 that the imported model was created in the format of an RFC3339 datetime string. format: date-time type: string timeUpdated: description: The date and time that the imported model was updated in the format of an RFC3339 datetime string. format: date-time type: string vendor: description: The provider of the imported model. maxLength: 255 minLength: 1 type: string version: description: The version of the imported model. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - timeCreated - lifecycleState - dataSource type: object UpdateHostedApplicationBaseDetails: description: Common update properties shared by HostedApplication and HostedApplicationIam. 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 hosted application. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string environmentVariables: description: 'The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime. ' items: $ref: '#/components/schemas/EnvironmentVariable' maxItems: 1000 type: array 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 scalingConfig: $ref: '#/components/schemas/ScalingConfig' type: object WorkRequestErrorCollection: description: A list of work request errors. Can contain 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, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. properties: isEnabled: description: Whether to enable the content moderation feature. type: boolean mode: default: INFORM description: Enum for the modes of operation for inference protection. enum: - INFORM - BLOCK type: string modelId: description: The OCID of the model used for the feature. type: string required: - isEnabled type: object CreateGenerativeAiProjectDetails: description: The data to create a GenerativeAiProject. properties: compartmentId: description: Owning compartment OCID for a GenerativeAiProject. maxLength: 255 minLength: 1 type: string conversationConfig: $ref: '#/components/schemas/ConversationConfig' 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 GenerativeAiProject. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: A user-friendly name. maxLength: 255 minLength: 1 type: string x-default-description: 'null' 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 longTermMemoryConfig: $ref: '#/components/schemas/LongTermMemoryConfig' shortTermMemoryOptimizationConfig: $ref: '#/components/schemas/ShortTermMemoryOptimizationConfig' required: - compartmentId type: object ChangeModelCompartmentDetails: description: 'The details to move a custom model to another compartment. ' properties: compartmentId: description: The compartment OCID to create the model in. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeGenerativeAiProjectCompartmentDetails: description: The details to move a GenerativeAiProject to another compartment. properties: compartmentId: description: The OCID of the compartment to move the GenerativeAiProject to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeSemanticStoreCompartmentDetails: description: The details to move a SemanticStore to another compartment. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the SemanticStore to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object HostedApplication: allOf: - $ref: '#/components/schemas/HostedApplicationBase' - properties: inboundAuthConfig: $ref: '#/components/schemas/InboundAuthConfig' type: object description: 'Hosted Application, defines shared configurations that apply across multiple deployments of the Agent or MCP application. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](/iaas/Content/generative-ai/iam-policies.htm). ' IdcsAuthConfig: description: 'Oracle Identity Cloud Service (IDCS) configuration used when inboundAuthConfigType is set to IDCS_AUTH_CONFIG. This object must be specified when inboundAuthConfigType is IDCS_AUTH_CONFIG. ' properties: audience: description: Audience for IDCS. type: string x-default-description: 'null' domainUrl: description: Domain URL for IDCS. type: string scope: description: Scope for IDCS. type: string required: - domainUrl - scope type: object VectorStoreConnectorCollection: description: 'Results of a VectorStoreConnector search. Contains VectorStoreConnectorSummary items. ' properties: items: description: List of VectorStoreConnector objects. items: $ref: '#/components/schemas/VectorStoreConnectorSummary' type: array required: - items type: object ChangeDedicatedAiClusterCompartmentDetails: description: The details to move a dedicated AI cluster to another compartment. properties: compartmentId: description: The OCID of the compartment to move the dedicated AI cluster to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object GenerativeAiPrivateEndpointSummary: description: 'List of Generative AI private endpoints. ' properties: compartmentId: description: 'The OCID of the compartment that contains the private endpoint. ' 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 description of this private endpoint. ' maxLength: 400 minLength: 1 type: string displayName: description: 'A user-friendly name. It doesn''t have to be unique. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string fqdn: description: 'Fully qualified domain name the customer will use for access ' 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 of a private endpoint. ' maxLength: 255 minLength: 1 type: string isAllowOnDemand: default: false description: 'Flag that allows access to on-demand models using this private endpoint. ' type: boolean lifecycleDetails: description: 'Details of the state of a private endpoint. ' maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the Generative AI Private Endpoint. type: string x-obmcs-enumref: '#/definitions/GenerativeAiPrivateEndpoint/lifecycleState' privateEndpointIp: description: 'The private IP address (in the customer''s VCN) that represents the access point for the associated endpoint service. ' maxLength: 40 minLength: 2 type: string resourceType: description: 'The resource type that Generative AI private endpoint can be used for. ' type: string x-obmcs-enumref: '#/definitions/GenerativeAiPrivateEndpoint/resourceType' securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object subnetId: description: 'The OCID of a subnet. ' maxLength: 255 minLength: 1 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 that the Generative AI private endpoint was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time that the Generative AI private endpoint was updated expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - subnetId - fqdn - timeCreated - timeUpdated type: object CreateVectorStoreConnectorFileSyncDetails: description: The data to create a VectorStoreConnectorFileSync. 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 displayName: description: A user-friendly name. 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 vectorStoreConnectorId: description: An OCID that identifies the VectorStoreConnector under which this FileSync operation is created. type: string required: - vectorStoreConnectorId type: object WorkRequestLogEntryCollection: description: A list of work request logs. Can contain 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 ModelMetrics: description: Model metrics during the creation of a new model. discriminator: propertyName: modelMetricsType properties: modelMetricsType: description: The type of the model metrics. Each type of model can expect a different set of model metrics. enum: - TEXT_GENERATION_MODEL_METRICS - CHAT_MODEL_METRICS type: string required: - modelMetricsType parameters: NameQueryParam: description: A filter to return only resources that match the given name exactly. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PrivateEndpointIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. in: query name: generativeAiPrivateEndpointId x-default-description: 'null' schema: type: string VectorStoreConnectorSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `name` is ascending. ' in: query name: sortBy schema: type: string enum: - name - timeCreated default: timeCreated 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 VectorStoreConnectorIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector. in: query name: vectorStoreConnectorId x-default-description: 'null' schema: type: string GenerativeAiProjectLifecycleStateQueryParam: description: A filter to return only resources whose lifecycle state matches the given value. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/GenerativeAiProject/lifecycleState' schema: type: string ModelLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/Model/lifecycleState' schema: type: string HostedDeploymentIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. in: query name: id x-default-description: 'null' schema: type: string DedicatedAiClusterIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster. in: path name: dedicatedAiClusterId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or '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 ModelIdentifierQueryParam: description: The ID of the model. in: query name: id schema: type: string EndpointLifecycleStateQueryParam: description: A filter to return only resources that their lifecycle state matches the given lifecycle state. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/Endpoint/lifecycleState' schema: type: string HostedApplicationLifecycleStateQueryParam: description: A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/HostedApplicationBase/lifecycleState' 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 HostedApplicationStorageIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage. in: path name: hostedApplicationStorageId required: true schema: type: string CompartmentIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId required: false x-default-description: 'null' schema: type: string GenerativeAiPrivateEndpointSortByQueryParam: description: 'The field used to sort the results. Multiple fields aren''t supported. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated default: timeCreated DedicatedAiClusterSortByQueryParam: 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 - lifecycleState default: timeCreated HostedDeploymentSortByQueryParam: 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 - lifecycleState default: timeCreated ModelIdPathParam: description: The model OCID in: path name: modelId required: true schema: type: string VectorStoreConnectorFileSyncIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync. in: query name: id x-default-description: 'null' schema: type: string CapabilityQueryParam: description: A filter to return only resources their capability matches the given capability. in: query name: capability x-default-description: 'null' style: form explode: true schema: type: array items: enum: - TEXT_GENERATION - TEXT_SUMMARIZATION - TEXT_EMBEDDINGS - FINE_TUNE - CHAT - TEXT_RERANK type: string x-obmcs-top-level-enum: '#/definitions/ModelCapability' HostedApplicationStorageSortByQueryParam: 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 - lifecycleState default: timeCreated 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 ApiKeyLifecycleStateQueryParam: description: A filter to return only resources that their lifecycle state matches the given lifecycle state. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/ApiKey/lifecycleState' schema: type: string ModelVendorQueryParam: description: A filter to return only resources that match the entire vendor given. in: query name: vendor x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 HostedApplicationStorageLifecycleStateQueryParam: description: A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/HostedApplicationStorage/lifecycleState' 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 - FAILED - SUCCEEDED - CANCELING - CANCELED GenerativeAiPrivateEndpointResourceTypeQueryParam: description: 'Query by the resource type of Generative AI private endpoints. ' in: query name: resourceType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/GenerativeAiPrivateEndpoint/resourceType' schema: type: string DedicatedAiClusterLifecycleStateQueryParam: description: A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/DedicatedAiCluster/lifecycleState' schema: type: string PrivateEndpointIdentifierQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. ' in: query name: id required: false x-default-description: 'null' schema: type: string WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string HostedApplicationIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application. in: query name: id x-default-description: 'null' schema: type: string HostedDeploymentLifecycleStateQueryParam: description: A filter to return only the hosted deployments that their lifecycle state matches the given lifecycle state. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/HostedDeployment/lifecycleState' schema: type: string ApiKeyIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey. in: path name: apiKeyId required: true schema: type: string GenerativeAiPrivateEndpointIdPathParam: description: 'The unique id for a Generative AI private endpoint. ' in: path name: generativeAiPrivateEndpointId required: true schema: type: string GenerativeAiProjectIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject. in: query name: id x-default-description: 'null' schema: type: string EndpointSortByQueryParam: 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: - displayName - timeCreated default: timeCreated VectorStoreIdentifierQueryParam: description: The openai compatible id of the VectorStore. in: query name: vectorStoreId x-default-description: 'null' 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 VectorStoreConnectorFileSyncSortByQueryParam: 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: - displayName - timeCreated default: timeCreated 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 x-default-description: 'null' schema: type: string minLength: 1 ImportedModelSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. ' in: query name: sortBy schema: type: string enum: - displayName - lifecycleState - timeCreated default: timeCreated VectorStoreConnectorFileSyncIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync. in: path name: vectorStoreConnectorFileSyncId required: true schema: type: string VectorStoreConnectorIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector. in: path name: vectorStoreConnectorId required: true schema: type: string HostedDeploymentIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. in: path name: hostedDeploymentId required: true schema: type: string VectorStoreConnectorLifecycleStateQueryParam: description: A filter to return only resources whose lifecycle state matches the given value. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/VectorStoreConnector/lifecycleState' schema: type: string GenerativeAiProjectSortByQueryParam: 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: - displayName - timeCreated default: timeCreated SemanticStoreIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore. in: query name: id x-default-description: 'null' schema: type: string ImportedModelLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/ImportedModel/lifecycleState' schema: type: string DedicatedAiClusterIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster. in: query name: id x-default-description: 'null' schema: type: string HostedApplicationStorageTypeQueryParam: description: The type of the hosted application storage. in: query name: hostedApplicationStorageType x-default-description: 'null' x-obmcs-enumref: '#/definitions/HostedApplicationStorage/storageType' 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 ArtifactIdentifierPathParam: description: The id of the artifact. in: path name: artifactId required: true schema: type: string HostedApplicationStorageIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage. in: query name: id x-default-description: 'null' schema: type: string HostedApplicationSortByQueryParam: 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 - lifecycleState default: timeCreated 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 ApiKeyIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey. in: query name: id x-default-description: 'null' schema: type: string SemanticStoreSortByQueryParam: 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: - displayName - timeCreated default: timeCreated 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 IngestionLogsSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `status` is ascending. ' in: query name: sortBy schema: type: string enum: - status - fileSize - filePath default: status SemanticStoreQueryingConnectionIdQueryParam: description: 'A filter to return only resources whose queryingConnectionId matches with this id. ' in: query name: dataSourceQueryingConnectionId x-default-description: 'null' schema: type: string VectorStoreConnectorFileStatusQueryParam: description: A filter to return only the Sync Logs whose status matches the given value. in: query name: status x-default-description: 'null' x-obmcs-enumref: '#/definitions/VectorStoreConnectorIngestionLogs/status' schema: type: string ApplicationIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HostedApplication parent. in: query name: applicationId x-default-description: 'null' schema: type: string ModelSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. ' in: query name: sortBy schema: type: string enum: - displayName - lifecycleState - timeCreated default: timeCreated VectorStoreConnectorIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector. in: query name: id x-default-description: 'null' schema: type: string VectorStoreConnectorFileSyncLifecycleStateQueryParam: description: A filter to return only resources whose lifecycle state matches the given value in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/VectorStoreConnectorFileSync/lifecycleState' schema: type: string ApiKeySortByQueryParam: 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: - displayName - timeCreated default: timeCreated ImportedModelCapabilityQueryParam: description: A filter to return only resources their capability matches the given capability. in: query name: capability x-default-description: 'null' style: form explode: true schema: type: array items: enum: - TEXT_TO_TEXT - IMAGE_TEXT_TO_TEXT - EMBEDDING - RERANK type: string x-obmcs-top-level-enum: '#/definitions/ImportedModelCapability' GenerativeAiPrivateEndpointLifecycleStateQueryParam: description: 'The lifecycle state of Generative AI private endpoints. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/GenerativeAiPrivateEndpoint/lifecycleState' 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 required: true x-default-description: 'null' schema: type: string GenerativeAiProjectIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject. in: path name: generativeAiProjectId required: true 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 FileSyncIngestionLogsSortByQueryParam: description: "The field to sort by. You can provide only one sort order. Default order for `status` is ascending. \n" in: query name: sortBy schema: type: string enum: - status - fileSize - filePath default: status HostedApplicationIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application. in: path name: hostedApplicationId required: true schema: type: string HostedApplicationIamIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application. in: path name: hostedApplicationIamId required: true schema: type: string EndpointIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint. in: query name: id x-default-description: 'null' schema: type: string ImportedModelVendorQueryParam: description: A filter to return only resources that match the entire vendor given. in: query name: vendor x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ImportedModelIdPathParam: description: The importedModel OCID in: path name: importedModelId required: true schema: type: string SemanticStoreLifecycleStateQueryParam: description: A filter to return only resources whose lifecycle state matches the given array. in: query name: lifecycleState x-default-description: 'null' style: form explode: true schema: type: array items: enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string SemanticStoreIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore. in: path name: semanticStoreId required: true schema: type: string ImportedModelIdentifierQueryParam: description: The ID of the importedModel. in: query name: id schema: type: string EndpointIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint. in: path name: endpointId 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-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. 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-httpStatuses: 400: description: A bad request was made or the request is not supported for the current tenant. 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. ' type: string schema: $ref: '#/components/schemas/Error' 401: description: User authentication has failed. 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. ' type: string schema: $ref: '#/components/schemas/Error' 403: description: Not authorized or not found. 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. ' type: string schema: $ref: '#/components/schemas/Error' 404: description: Not authorized or not found. 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. ' type: string schema: $ref: '#/components/schemas/Error' 409: description: Conflict 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. ' type: string schema: $ref: '#/components/schemas/Error' 500: description: Internal server 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. ' type: string schema: $ref: '#/components/schemas/Error' default: description: An error has occurred. 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. ' type: string schema: $ref: '#/components/schemas/Error' 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 securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' 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-obmcs-endpoint-service-name: generativeai x-oracle-package: com.oracle.oci.ocas.generative