Azure OpenAI i Microsoft Foundry Models REST API-referens (klassisk)

Visar för närvarande:Foundry-portalversion - (klassisk)Växla till version för den nya Foundry-portalen

Denna artikel ger detaljer om slutpunkterna för REST API för Azure OpenAI.

API-specifikationer

Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelad över tre huvudsakliga API-ytor:

• Kontrollplan
• Dataplan – författarskap
• Dataplan – inferens

Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har sin egen unika uppsättning förhandsvisningar och stabila/allmänt tillgängliga (GA) API-releaser. Förhandsvisningar följer för närvarande en månatlig rytm.

Authentication

Azure OpenAI erbjuder två metoder för autentisering. Du kan använda antingen API-nycklar eller Microsoft Entra ID.

• API-nyckelautentisering: För denna typ av autentisering måste alla API-förfrågningar inkludera API-nyckeln i api-key HTTP-headern. Quickstart ger vägledning för hur man gör samtal med denna typ av autentisering.

• Microsoft Entra ID autentisering: Du kan autentisera ett API-anrop med en Microsoft Entra-token. Autentiseringstoken ingår i en förfrågan som Authorization header. Den givna token måste föregås av Bearer, till exempel Bearer YOUR_AUTH_TOKEN. Du kan läsa vår guide om autentisera med Microsoft Entra ID.

REST API-versionshantering

Tjänste-API:erna versioneras med hjälp av frågeparametern api-version . Alla versioner följer YYYY-MM-DD datumstrukturen. Ett exempel:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Dataplansinferens

Resten av artikeln täcker GA:s version av Azure OpenAI:s specifikation för dataplansinferens, 2024-10-21.

Om du letar efter dokumentation om den senaste förhandsversionen av API:et läser du det senaste api:et för förhandsversion av dataplanets slutsatsdragning.

Avslutningar

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

Skapar en komplettering för den tillhandahållna prompten, parametrarna och den valda modellen.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Examples

Example

Skapar en komplettering för den tillhandahållna prompten, parametrarna och den valda modellen.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Svar: Statuskod: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Inbäddningar

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

Få en vektorrepresentation av en given input som enkelt kan konsumeras av maskininlärningsmodeller och algoritmer.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Responses

Egenskaper för användning

prompt_tokens

total_tokens

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnera embeddingarna för en given prompt.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "input": [
  "this is a test"
 ]
}

Svar: Statuskod: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Chatten har slutförts

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

Skapar en komplettering för chattmeddelandet

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Examples

Example

Skapar en komplettering för den tillhandahållna prompten, parametrarna och den valda modellen.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Svar: Statuskod: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Skapar en komplettering baserad på Azure Search-data och systemtilldelad hanterad identitet.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Svar: Statuskod: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Skapar en komplettering baserad på Azure Search-vektordata, tidigare assistentmeddelande och användartilldelad hanterad identitet.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Svar: Statuskod: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Skapar en komplettering för den medföljande Azure Cosmos DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Svar: Statuskod: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transkriptioner - Skapa

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Transkriberar ljudet till inmatningsspråket.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Får transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Svar: Statuskod: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Får transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Svar: Statuskod: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Översättningar - Skapa

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

Transkriberar och översätter inmatat ljud till engelsk text.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar engelskspråkig transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Svar: Statuskod: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Hämtar engelskspråkig transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Svar: Statuskod: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Bildgenerering

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Genererar en batch bilder från en texttext på en given dall-e-modelldistribution

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: Ok

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

Example

Skapar bilder med en prompt.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Svar: Statuskod: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Components

errorResponse

errorBase

fel

innerError

Inre fel med ytterligare detaljer.

innerErrorCode

Felkoder för det inre felobjektet.

Beskrivning: Felkoder för det inre felobjektet.

Typ: sträng

Standard:

Enumnamn: InnerErrorCode

Uppräkningsvärden:

dalleErrorResponse

dalleError

dalleInnerError

Inre fel med ytterligare detaljer.

Resultat av Innehållsfilterbas

innehållsfilterallvarlighetsresultat

Resultat för innehållsfilter upptäckt

innehållsfilter upptäckt med citeringsresultat

Egenskaper för citering

URL

license

innehållFilterResultatBas

Information om innehållet filtreringsresultat.

contentFilterPromptResults

Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har upptäckts och om det har filtrerats eller inte. Och information om kundblocklistan, om den har filtrerats och dess ID.

resultatFörInnehållsfilterVal

Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om tredjepartstext och svordomar, om det har upptäckts och om det har filtrerats eller inte. Och information om kundblocklistan, om den har filtrerats och dess ID.

uppmaningsfilterresultat

Innehållsfiltrering resulterar för en enda prompt i förfrågan.

uppmaningsfilterresultat

Innehållsfiltrering ger noll eller fler promptar i förfrågan. I en streamingförfrågan kan resultaten för olika prompts komma vid olika tidpunkter eller i olika ordning.

Inga egenskaper definierade för denna komponent.

dalle innehållsfilterresultat

Information om innehållet filtreringsresultat.

dalleFilterResults

Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har upptäckts och om det har filtrerats eller inte. Och information om kundblocklistan, om den har filtrerats och dess ID.

chatCompletionsRequestCommon

skapaFärdigställandebegäran

createCompletionResponse

Representerar ett fullbordandesvar från API:et. Observera: både de strömmade och icke-strömmade svarsobjekten har samma form (till skillnad från chattändpunkten).

SkapaChattSlutförandeBegäran

chattavslutningsfunktioner

chattkompletteringsfunktionanropsalternativ

Att specificera en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.

förfrågningsmeddelande för chattkomplettering

Denna komponent kan vara en av följande:

chatCompletionRequestSystemMessage

chatCompletionRequestUserMessage

chatCompletionRequestAssistantMessage

Egenskaper för function_call

arguments

name

chatCompletionRequestToolMessage

chatCompletionRequestFunctionMessage

chat-komplettering-begäran-systemmeddelande-innehållsdel

Denna komponent kan vara en av följande:

chattSlutförandeBegäranAnvändarMeddelandeInnehållsDel

Denna komponent kan vara en av följande:

chatkompletteringBegäranAssistentMeddelandeInnehållDel

Denna komponent kan vara en av följande:

Meddelandeinnehållsdel för verktygsförfrågan om chattkomplettering

Denna komponent kan vara en av följande:

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartImage

Egenskaper för image_url

url

detail

chatCompletionRequestMessageContentPartRefusal

azurechattilläggskonfiguration

En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI.

azureChatExtensionType

En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI.

Description: En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI.

Typ: sträng

Standard:

Uppräkningsnamn: AzureChatExtensionType

Uppräkningsvärden:

AzureSearch-chattilläggskonfiguration

En specifik representation av konfigurerbara alternativ för Azure Search när man använder det som en Azure OpenAI-chatttillägg.

azureSearchChatExtensionParameters

Parametrar för Azure Search när de används som en Azure OpenAI-chatttillägg.

alternativ för mappning av fält i Azure-sökindex

Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Azure Search-resurs.

azureSökfrågetyp

Den typ av Azure Search-sökning som ska utföras när den används som en Azure OpenAI-chatttillägg.

Description: Den typ av Azure Search-sökningssökning som ska utföras när den används som en Azure OpenAI-chatttillägg.

Typ: sträng

Standard:

Uppräkningsnamn: AzureSearchQueryType

Uppräkningsvärden:

azureCosmosDBChatExtensionConfiguration

En specifik representation av konfigurerbara alternativ för Azure Cosmos DB när man använder det som en Azure OpenAI-chatttillägg.

azureCosmosDBChatExtensionParameters

Parametrar att använda när man konfigurerar Azure OpenAI On Your Data chatttillägg när man använder Azure Cosmos DB för MongoDB vCore.

azureCosmosDBFieldMappingOptions

Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Azure Cosmos DB-resurs.

dinaDataAutentiseringsalternativ

Autentiseringsalternativen för Azure OpenAI On Your Data.

påDinDataAutentiseringstyp

De autentiseringstyper som stöds med Azure OpenAI On Your Data.

Beskrivning: De autentiseringstyper som stöds med Azure OpenAI On Your Data.

Typ: sträng

Standard:

Enum-namn: OnYourDataAuthenticationType

Uppräkningsvärden:

onYourDataApiNyckelAutentiseringsalternativ

Autentiseringsalternativen för Azure OpenAI på dina data när du använder en API-nyckel.

påDinDataAnslutningssträngAutentiseringsalternativ

Autentiseringsalternativen för Azure OpenAI On Your Data när man använder en reťazec pripojenia.

alternativ för autentisering av tilldelad hanterad identitet i datorsystemet

Autentiseringsalternativen för Azure OpenAI på dina data när du använder en systemtilldelad hanterad identitet.

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI On Your Data när man använder en användartilldelad hanterad identitet.

onDinDataVektoriseringKälla

En abstrakt representation av en vektoriseringskällkod för Azure OpenAI On Your Data med vektorsökning.

påDinDatavektoriseringsKälltyp

Representerar de tillgängliga källor som Azure OpenAI On Your Data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.

Description: Representerar de tillgängliga källorna Azure OpenAI On Your Data kan använda för att konfigurera vektorisering av data för användning med
vektorsökning.

Typ: sträng

Standard:

Enum-namn: OnYourDataVectorizationSourceType

Uppräkningsvärden:

onYourDataDeploymentNameVectorizationSource

Detaljerna i en vektoriseringskälla, som används av Azure OpenAI On Your Data vid tillämpning av vektorsökning, som baseras på ett internt inbäddningsmodell-distributionsnamn i samma Azure OpenAI-resurs.

onYourDataEndpointVectorizationSource

Detaljerna i en vektoriseringskälla, som används av Azure OpenAI On Your Data vid tillämpning av vektorsökning, som baseras på ett offentligt Azure OpenAI-slutpunktsanrop för inbäddningar.

Azure-chatförlängningsmeddelandesammanhang

En representation av den ytterligare kontextinformation som finns tillgänglig när Azure OpenAI-chatttillägg är involverade i genereringen av ett motsvarande svar på chattkompletteringar. Denna kontextinformation fylls endast i när man använder en Azure OpenAI-förfrågan konfigurerad för att använda en matchande tillägg.

Citat

Källhänvisningsinformation för ett svar på chattfullföljningar.

verktygsanrop för meddelandeavslutning

Egenskaper för funktion

name

arguments

verktygsanropstyp

Typen av verktygskall, i detta fall function.

Beskrivning: Typen av verktygsanrop, i detta fall function.

Typ: sträng

Standard:

Enum-namn: ToolCallType

Uppräkningsvärden:

chattavslutningsförfråganmeddelandeverktyg

chatCompletionRequestMessageFunction

createChatCompletionResponse (skapaChatCompletionRespons)

Representerar ett chattfullbordandesvar som returneras av modellen, baserat på den tillhandahållna indatan.

createChatCompletionStreamResponse

Representerar en strömmad del av ett chattfullbordande svar som returneras av modellen, baserat på den tillhandahållna inmatningen.

chatCompletionStreamResponseDelta

En chattfullbordandedelta som genereras av strömmade modellsvar.

Egenskaper för function_call

arguments

name

Meddelandeverktyg för chattfullständighetssamtalstycke

Egenskaper för funktion

name

arguments

chatCompletionStreamOptions

Alternativ för streaming-respons. Ställ in detta först när du sätter stream: true.

chatCompletionChoiceLogProbs

Logga sannolikhetsinformation för valet.

chatCompletionTokenLogprob

chatslutförandemeddelande

Ett meddelande om chattkomplettering genererat av modellen.

chattSlutförandeSvarMeddelandeRoll

Författarens roll för svarsmeddelandet.

Beskrivning: Författarens roll för svarsmeddelandet.

Typ: sträng

Standard:

Uppräkningsvärden:

• Assistent

chatCompletionToolChoiceOption

Styr vilket (om något) verktyg som anropas av modellen. none Det betyder att modellen inte anropar något verktyg utan istället genererar ett meddelande. auto Det innebär att modellen kan välja mellan att generera ett meddelande eller att anropa ett eller flera verktyg. required betyder att modellen måste anropa ett eller flera verktyg. Att specificera ett visst verktyg via {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget. none är standarden när inga verktyg finns. auto är standarden om verktyg finns.

Denna komponent kan vara en av följande:

chatCompletionNamedToolChoice

Specificerar ett verktyg som modellen ska använda. Använd för att tvinga modellen att anropa en specifik funktion.

Egenskaper för funktion

name

ParallelToolCalls

Om man ska aktivera parallell funktionsanrop under verktygsanvändning.

Inga egenskaper definierade för denna komponent.

chattKompletteringsmeddelandeVerktygSamtal

Verktygsanropen som genereras av modellen, såsom funktionsanrop.

Inga egenskaper definierade för denna komponent.

chatCompletionFunctionCall

Föråldrad och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.

slutanvändning

Användningsstatistik för förfrågan om fullbordan.

Egenskaper för completion_tokens_details

reasoning_tokens

Chattkompletteringsverktyg

FunctionParameters

De parametrar som funktionen accepterar, beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON Schema-referensen för dokumentation om formatet.

Att parameters utelämna definierar en funktion med en tom parameterlista.

Inga egenskaper definierade för denna komponent.

FunctionObject

ResponseFormatText

ResponseFormatJsonObject

ResponseFormatJsonSchemaSchema

Schemat för svarsformatet, beskrivet som ett JSON Schema-objekt.

Inga egenskaper definierade för denna komponent.

ResponsformatJsonSchema

Egenskaper för json_schema

description

name

schema

Strikt

Alternativ för att slutföra chatt

skapa översättningsförfrågan

Översättningsbegäran.

ljudsvar

Översättnings- eller transkriptionssvar när response_format var json

audioVerboseResponse

Översättnings- eller transkriptionssvar när response_format var verbose_json

audioResponseFormat

Definierar formatet på utdatan.

Beskrivning: Definierar formatet på utdatan.

Typ: sträng

Standard:

Uppräkningsvärden:

• json
• text
• srt
• verbose_json
• vtt

skapaTranskriberingsBegäran

Transkriptionsbegäran.

ljudsegment

Transkriberings- eller översättningssegment.

bildkvalitet

Bildkvaliteten som kommer att genereras.

Beskrivning: Kvaliteten på bilden som kommer att genereras.

Typ: sträng

Standard: standard

Enum-namn: Kvalitet

Uppräkningsvärden:

imagesResponseFormat

Formatet i vilket de genererade bilderna returneras.

Beskrivning: Formatet i vilket de genererade bilderna returneras.

Typ: sträng

Standard: url

Enum-namn: ImagesResponseFormat

Uppräkningsvärden:

imageSize

Storleken på de genererade bilderna.

Beskrivning: Storleken på de genererade bilderna.

Typ: sträng

Standard: 1024x1024

Enum-namn: Storlek

Uppräkningsvärden:

imageStyle

Stilen på de genererade bilderna.

Beskrivning: Stilen på de genererade bilderna.

Typ: sträng

Standard: levande

Enum-namn: Stil

Uppräkningsvärden:

bildgenereringsförfrågan

skapaBildsvar

bildresultat

Bild-url:en eller kodad bild om den lyckas, och ett fel annars.

Tillägg för slutföranden

Completions-tillägg ingår inte i den senaste GA-versionen av Azure OpenAI:s dataplansinferensspecifikation.

Chattmeddelande

Chatmeddelandeobjektet ingår inte i den senaste GA-versionen av Azure OpenAI:s dataplansinferensspecifikation.

Text-till-tal (Förhandsvisning)

Ingår för närvarande inte i den senaste Azure OpenAI GA-versionen av Azure OpenAI:s specifikation för dataplansinferens. Se den senaste versionen preview för denna funktion.

Nästa steg

Lär dig om modeller och finjustering med REST API. Läs mer om underlying modeller som driver Azure OpenAI.