{ "opencollection": "1.0.0", "info": { "name": "Service Management Generative AI API", "version": "20231130" }, "items": [ { "info": { "name": "GenerativeAi", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of ApiKeys.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/apikeys", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that their lifecycle state matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the ApiKeys of a specific compartment." }, { "info": { "name": "Creates an API key.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/apikeys", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new API key in the specified compartment." }, { "info": { "name": "Get API Key", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/apikeys/:apiKeyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey." } ] }, "docs": "Gets information about an API key." }, { "info": { "name": "Updates an ApiKey.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/apikeys/:apiKeyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an apiKey." }, { "info": { "name": "Deletes an API key.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/apikeys/:apiKeyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey." } ] }, "docs": "Deletes an API key." }, { "info": { "name": "Moves an API key into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/apikeys/:apiKeyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Renew the primary or secondary key.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/apikeys/:apiKeyId/actions/renew", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renew the primary or secondary key." }, { "info": { "name": "Set state of the key.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/apikeys/:apiKeyId/actions/setstate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the APIKey." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set state of the key." }, { "info": { "name": "Gets a list of DedicatedAiClusters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/dedicatedAiClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the dedicated AI clusters in a specific compartment." }, { "info": { "name": "Creates a DedicatedAiCluster.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/dedicatedAiClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a dedicated AI cluster." }, { "info": { "name": "Get DedicatedAiCluster", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/dedicatedAiClusters/:dedicatedAiClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dedicatedAiClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster." } ] }, "docs": "Gets information about a dedicated AI cluster." }, { "info": { "name": "Updates a DedicatedAiCluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/dedicatedAiClusters/:dedicatedAiClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dedicatedAiClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a dedicated AI cluster." }, { "info": { "name": "Deletes a dedicated AI cluster.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/dedicatedAiClusters/:dedicatedAiClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dedicatedAiClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster." } ] }, "docs": "Deletes a dedicated AI cluster.\n\nYou 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.\n" }, { "info": { "name": "Moves a DedicatedAiCluster into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/dedicatedAiClusters/:dedicatedAiClusterId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dedicatedAiClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Gets a list of Endpoints.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/endpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that their lifecycle state matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." }, { "name": "generativeAiPrivateEndpointId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the endpoints of a specific compartment." }, { "info": { "name": "Creates a Endpoint.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/endpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an endpoint.\n\nThe header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.\n" }, { "info": { "name": "Get Endpoint", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/endpoints/:endpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "endpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ] }, "docs": "Gets information about an endpoint." }, { "info": { "name": "Updates a Endpoint.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/endpoints/:endpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "endpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an endpoint." }, { "info": { "name": "Deletes an endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/endpoints/:endpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "endpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ] }, "docs": "Deletes an endpoint." }, { "info": { "name": "Moves an endpoint into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/endpoints/:endpointId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "endpointId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "List the Generative AI private endpoints.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/generativeAiPrivateEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of Generative AI private endpoints.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort the results. Multiple fields aren't supported.\n" }, { "name": "resourceType", "value": "", "type": "query", "description": "Query by the resource type of Generative AI private endpoints.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Lists all Generative AI private endpoints in the specified compartment.\n" }, { "info": { "name": "Create a Generative AI private endpoint.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/generativeAiPrivateEndpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Generative AI private endpoint.\n" }, { "info": { "name": "Get a Generative AI private endpoint.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/generativeAiPrivateEndpoints/:generativeAiPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "generativeAiPrivateEndpointId", "value": "", "type": "path", "description": "The unique id for a Generative AI private endpoint.\n" } ] }, "docs": "Retrieves an Generative AI private endpoint using a `privateEndpointId`.\n" }, { "info": { "name": "Update a Generative AI private endpoint.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/generativeAiPrivateEndpoints/:generativeAiPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "generativeAiPrivateEndpointId", "value": "", "type": "path", "description": "The unique id for a Generative AI private endpoint.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Generative AI private endpoint using a `privateEndpointId`.\n" }, { "info": { "name": "Delete a Generative AI private endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/generativeAiPrivateEndpoints/:generativeAiPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "generativeAiPrivateEndpointId", "value": "", "type": "path", "description": "The unique id for a Generative AI private endpoint.\n" } ] }, "docs": "Deletes a Generative AI private endpoint using `privateEndpointId`.\n" }, { "info": { "name": "Moves a Generative AI private endpoint into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/generativeAiPrivateEndpoints/:generativeAiPrivateEndpointId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "generativeAiPrivateEndpointId", "value": "", "type": "path", "description": "The unique id for a Generative AI private endpoint.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Generative AI private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Gets a list of GenerativeAiProjects.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/generativeAiProjects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycle state matches the given value." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the generativeAiProjects of a specific compartment." }, { "info": { "name": "Creates a GenerativeAiProject.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/generativeAiProjects", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a GenerativeAiProject.\nThe header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the generativeAiProject creation progress.\n" }, { "info": { "name": "Get GenerativeAiProject", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/generativeAiProjects/:generativeAiProjectId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "generativeAiProjectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject." } ] }, "docs": "Gets information about a generativeAiProject." }, { "info": { "name": "Updates a GenerativeAiProject.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/generativeAiProjects/:generativeAiProjectId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "generativeAiProjectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a generativeAiProject." }, { "info": { "name": "Deletes a generativeAiProject.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/generativeAiProjects/:generativeAiProjectId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "generativeAiProjectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject." } ] }, "docs": "Deletes a generativeAiProject." }, { "info": { "name": "Moves a generativeAiProject into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/generativeAiProjects/:generativeAiProjectId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "generativeAiProjectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Gets a list of HostedApplicationStorages.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedApplicationStorages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state." }, { "name": "hostedApplicationStorageType", "value": "", "type": "query", "description": "The type of the hosted application storage." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the hosted application storage in a specific compartment." }, { "info": { "name": "Creates a Hosted Application Storage.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedApplicationStorages", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a hosted application storage." }, { "info": { "name": "Get Hosted Application Storage", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedApplicationStorages/:hostedApplicationStorageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationStorageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage." } ] }, "docs": "Gets information about a hosted application storage." }, { "info": { "name": "Deletes a hosted application.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/hostedApplicationStorages/:hostedApplicationStorageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationStorageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage." } ] }, "docs": "Deletes a hosted application.\nYou 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.\n" }, { "info": { "name": "Moves a Application Storage into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedApplicationStorages/:hostedApplicationStorageId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostedApplicationStorageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Gets a list of HostedApplications.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedApplications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the hosted applications in a specific compartment." }, { "info": { "name": "Creates a HostedApplication.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedApplications", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a hosted application." }, { "info": { "name": "Get HostedApplication", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedApplications/:hostedApplicationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ] }, "docs": "Gets information about a hosted application." }, { "info": { "name": "Updates a HostedApplication.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/hostedApplications/:hostedApplicationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a hosted application." }, { "info": { "name": "Deletes a hosted application.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/hostedApplications/:hostedApplicationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ] }, "docs": "Deletes a hosted application.\nYou 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.\n" }, { "info": { "name": "Moves a HostedApplication into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedApplications/:hostedApplicationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostedApplicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Gets a list of HostedApplicationsIam.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedApplicationsIam", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the hosted applications in a specific compartment." }, { "info": { "name": "Creates a HostedApplicationIam.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedApplicationsIam", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a hosted application." }, { "info": { "name": "Get HostedApplicationIam", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedApplicationsIam/:hostedApplicationIamId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationIamId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ] }, "docs": "Gets information about a hosted application." }, { "info": { "name": "Updates a HostedApplicationIam.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/hostedApplicationsIam/:hostedApplicationIamId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationIamId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a hosted application." }, { "info": { "name": "Deletes a hosted application.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/hostedApplicationsIam/:hostedApplicationIamId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedApplicationIamId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ] }, "docs": "Deletes a hosted application.\nYou 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.\n" }, { "info": { "name": "Moves a HostedApplicationIam into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedApplicationsIam/:hostedApplicationIamId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostedApplicationIamId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Gets a list of HostedDeployments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedDeployments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "applicationId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HostedApplication parent." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the hosted deployments that their lifecycle state matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the hosted applications in a specific compartment. Provide either applicationId or applicationIamId to filter by parent." }, { "info": { "name": "Creates a HostedDeployment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedDeployments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a hosted deployment." }, { "info": { "name": "Get Hosted Deployment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/hostedDeployments/:hostedDeploymentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedDeploymentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment." } ] }, "docs": "Gets information about a hosted deployment." }, { "info": { "name": "Updates a HostedDeployment.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/hostedDeployments/:hostedDeploymentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedDeploymentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a hosted deployment." }, { "info": { "name": "Deletes a hosted deployment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/hostedDeployments/:hostedDeploymentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedDeploymentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment." } ] }, "docs": "Deletes a hosted deployment.\nYou 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.\n" }, { "info": { "name": "Create Simple Docker Artifact", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/hostedDeployments/:hostedDeploymentId/artifacts", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostedDeploymentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "add image with isAutoDeploy flag." }, { "info": { "name": "delete artifact", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/hostedDeployments/:hostedDeploymentId/artifacts/:artifactId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostedDeploymentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment." }, { "name": "artifactId", "value": "", "type": "path", "description": "The id of the artifact." } ] }, "docs": "delete artifact." }, { "info": { "name": "Lists the currently available imported models.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/importedModels", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vendor", "value": "", "type": "query", "description": "A filter to return only resources that match the entire vendor given." }, { "name": "capability", "value": "", "type": "query", "description": "A filter to return only resources their capability matches the given capability." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The ID of the importedModel." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending.\n" } ] }, "docs": "Lists imported models in a specific compartment." }, { "info": { "name": "Import a model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/importedModels", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import a model from ModelDataSource.\n\nThe header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the importedModel creation progress.\n" }, { "info": { "name": "Retrieves a single imported model resource, providing basic information about the imported model", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/importedModels/:importedModelId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "importedModelId", "value": "", "type": "path", "description": "The importedModel OCID" } ] }, "docs": "Gets information about an imported model." }, { "info": { "name": "Updates an ImportedModel.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/importedModels/:importedModelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "importedModelId", "value": "", "type": "path", "description": "The importedModel OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an imported model such as name, description, freeform tags, and defined tags." }, { "info": { "name": "Deletes an importedModel.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/importedModels/:importedModelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "importedModelId", "value": "", "type": "path", "description": "The importedModel OCID" } ] }, "docs": "Deletes an imported model. An imported model shouldn't be deleted if there's one or more active endpoints associated with that imported model." }, { "info": { "name": "Moves an imported model into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/importedModels/:importedModelId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "importedModelId", "value": "", "type": "path", "description": "The importedModel OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Lists the currently available models.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/models", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vendor", "value": "", "type": "query", "description": "A filter to return only resources that match the entire vendor given." }, { "name": "capability", "value": "", "type": "query", "description": "A filter to return only resources their capability matches the given capability." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The ID of the model." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending.\n" } ] }, "docs": "Lists the models in a specific compartment. Includes pretrained base models and fine-tuned custom models." }, { "info": { "name": "Creates a Model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/models", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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..\n\nThe header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress.\n" }, { "info": { "name": "Retrieves a single model resource, providing basic information about the model", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/models/:modelId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "modelId", "value": "", "type": "path", "description": "The model OCID" } ] }, "docs": "Gets information about a custom model." }, { "info": { "name": "Updates a Model.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/models/:modelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "modelId", "value": "", "type": "path", "description": "The model OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags." }, { "info": { "name": "Deletes a model.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/models/:modelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "modelId", "value": "", "type": "path", "description": "The model OCID" } ] }, "docs": "Deletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with that model." }, { "info": { "name": "Moves a Model into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/models/:modelId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "modelId", "value": "", "type": "path", "description": "The model OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Gets a list of SemanticStores.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/semanticStores", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycle state matches the given array." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, { "name": "dataSourceQueryingConnectionId", "value": "", "type": "query", "description": "A filter to return only resources whose queryingConnectionId matches with this id.\n" } ] }, "docs": "Lists the SemanticStores given specific filter." }, { "info": { "name": "Creates a SemanticStore.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/semanticStores", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a SemanticStore.\n" }, { "info": { "name": "Get SemanticStore", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/semanticStores/:semanticStoreId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "semanticStoreId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore." } ] }, "docs": "Gets information about a semanticStore." }, { "info": { "name": "Updates a SemanticStore.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/semanticStores/:semanticStoreId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "semanticStoreId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a SemanticStore." }, { "info": { "name": "Deletes a semanticStore.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/semanticStores/:semanticStoreId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "semanticStoreId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore." } ] }, "docs": "Deletes a semanticStore." }, { "info": { "name": "Moves a SemanticStore into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/semanticStores/:semanticStoreId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "semanticStoreId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Gets a list of VectorStoreConnectorFileSyncs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/vectorStoreConnectorFileSyncs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycle state matches the given value" }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync." }, { "name": "vectorStoreConnectorId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the vectorStoreConnectorFileSyncs of a specific compartment." }, { "info": { "name": "Creates a File Sync operation for a VectorStoreConnector.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/vectorStoreConnectorFileSyncs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a File Sync operation for a VectorStoreConnector.\nThe header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnectorFileSync creation progress.\n" }, { "info": { "name": "Get the details of a VectorStoreConnectorFileSync Operation.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/vectorStoreConnectorFileSyncs/:vectorStoreConnectorFileSyncId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorFileSyncId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync." } ] }, "docs": "Gets information about a vectorStoreConnectorFileSync." }, { "info": { "name": "Cancels a vectorStoreConnectorFileSync operation.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/vectorStoreConnectorFileSyncs/:vectorStoreConnectorFileSyncId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorFileSyncId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync." } ] }, "docs": "Cancels a vectorStoreConnectorFileSync." }, { "info": { "name": "Get Ingestion logs for a VectorStoreConnectorFileSync operation.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/vectorStoreConnectorFileSyncs/:vectorStoreConnectorFileSyncId/ingestionLogs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorFileSyncId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycle state matches the given value" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `status` is ascending. \n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Gets Ingestion logs for a vectorStoreConnectorFileSync operation." }, { "info": { "name": "Gets a list of VectorStoreConnectors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/vectorStoreConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "vectorStoreId", "value": "", "type": "query", "description": "The openai compatible id of the VectorStore." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycle state matches the given value." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending.\nDefault order for `name` is ascending.\n" } ] }, "docs": "Lists the vectorStoreConnectors of a specific compartment." }, { "info": { "name": "Creates a VectorStoreConnector.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/vectorStoreConnectors", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a VectorStoreConnector.\nThe header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnector creation progress.\n" }, { "info": { "name": "Get VectorStoreConnector", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/vectorStoreConnectors/:vectorStoreConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector." } ] }, "docs": "Gets information about a vectorStoreConnector." }, { "info": { "name": "Updates a VectorStoreConnector.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20231130/vectorStoreConnectors/:vectorStoreConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a vectorStoreConnector." }, { "info": { "name": "Deletes a vectorStoreConnector.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20231130/vectorStoreConnectors/:vectorStoreConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector." } ] }, "docs": "Deletes a vectorStoreConnector." }, { "info": { "name": "Get Ingestion logs for a VectorStoreConnector", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/vectorStoreConnectors/:vectorStoreConnectorId/ingestionLogs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the Sync Logs whose status matches the given value." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `status` is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Gets Ingestion logs for a vectorStoreConnector." }, { "info": { "name": "Get Sync statistics of a VectorStoreConnector", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/vectorStoreConnectors/:vectorStoreConnectorId/stats", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vectorStoreConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector." } ] }, "docs": "Gets Sync statistics from a vectorStoreConnector." }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the resources that match the given lifecycle state." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the work requests in a compartment." }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Gets the details of a work request." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Lists the errors for a work request." }, { "info": { "name": "Lists the work request logs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Lists the logs for a work request." } ] } ], "bundled": true }