{ "opencollection": "1.0.0", "info": { "name": "Generative AI Service Inference Generative AI Inference API", "version": "20231130" }, "items": [ { "info": { "name": "GenerativeAiInference", "type": "folder" }, "items": [ { "info": { "name": "Applies guardrails to the input content", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/actions/applyGuardrails", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies guardrails to the input content, including content moderation, PII detection, and prompt injection protection.\nCase 1: Use `input` when the customer wants simple single-text moderation. Existing\ncustomers can continue to use this field without changing their current integration.\nCase 2: Use `multimodalInput` when the customer wants moderation over text, image, or a\ncombination of both.\n`multimodalInput` supports a single text item, an array of text items only, an array of\nimages only, or" }, { "info": { "name": "Creates a response for the given conversation.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/actions/chat", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a response for the given conversation.\n" }, { "info": { "name": "Produces embeddings (i.e. low-level numerical representation) of the inputs", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/actions/embedText", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Produces embeddings for the inputs.\n\nAn embedding is numeric representation of a piece of text. This text can be a phrase, a sentence, or one or more paragraphs. The Generative AI embedding model transforms each phrase, sentence, or paragraph that you input, into an array with 1024 numbers. You can use these embeddings for finding similarity in your input text such as finding phrases that are similar in context or category. Embeddings are mostly used for semantic searches where the search functi" }, { "info": { "name": "Generates a text response based on the user prompt. This operation is deprecated.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/actions/generateText", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a text response based on the user prompt.\n" }, { "info": { "name": "Rerank text response based on the input", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/actions/rerankText", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reranks the text responses based on the input documents and a prompt.\n\nRerank assigns an index and a relevance score to each document, indicating which document is most related to the prompt.\n" }, { "info": { "name": "Summarizes text response based on the input. This operation is deprecated.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20231130/actions/summarizeText", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Summarizes the input text.\n" }, { "info": { "name": "List the available guardrail system versions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20231130/guardrailVersions", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-compartment-id", "value": "" } ], "params": [ { "name": "state", "value": "", "type": "query", "description": "A filter to return only the guardrail versions whose 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" } ] }, "docs": "List the available guardrail system versions.\n" } ] } ], "bundled": true }