REST API-referens för Azure OpenAI i Azure AI Foundry Models

Den här artikeln innehåller information om rest-API-slutpunkterna för inferens för Azure OpenAI.

API-specifikationer

Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelade på tre primära API-ytor:

• Kontrollplan
• Dataplan – redigering
• Dataplan – slutsatsdragning

Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har en egen unik uppsättning förhandsversioner och stabila/allmänt tillgängliga API-versioner (GA). Förhandsversioner tenderar för närvarande att följa en månatlig takt.

Autentisering

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

• API-nyckelautentisering: För den här typen av autentisering måste alla API-begäranden innehålla API-nyckeln i api-key HTTP-huvudet. Snabbstarten innehåller vägledning för hur du gör anrop med den här typen av autentisering.

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

REST API-versionshantering

Tjänst-API:erna versionshanteras med frågeparametern api-version. Alla versioner följer datumstrukturen ÅÅÅÅÅ-MM-DD. Till exempel:

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

Slutsatsdragning av dataplan

Resten av artikeln beskriver den senaste GA-versionen av Inferensspecifikationen för Azure OpenAI-dataplanet, 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

Kompletteringar

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

Skapar ett slutförande för den angivna prompten, parametrarna och den valda modellen.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Svaren

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Exempel

Exempel

Skapar ett slutförande för den angivna 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 viss indata som enkelt kan användas av maskininlärningsmodeller och algoritmer.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Svaren

Egenskaper för användning

uppmaningstoken

total_tokens

Statuskod: 200

Beskrivning: OK

Exempel

Exempel

Returnera inbäddningarna för en viss fråga.

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 ett slutförande för chattmeddelandet

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Svaren

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Exempel

Exempel

Skapar ett slutförande för den angivna 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
    }
  }
}

Exempel

Skapar ett slutförande baserat 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
    }
  }
}

Exempel

Skapar ett slutförande baserat 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
    }
  }
}

Exempel

Skapar ett slutförande för den angivna 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 ljud till indataspråket.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: flera delar/formulärdata

Svaren

Statuskod: 200

Beskrivning: OK

Exempel

Exempel

Hämtar transkriberad text och associerade metadata från angivna talade 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"
  }
}

Exempel

Hämtar transkriberad text och associerade metadata från angivna talade 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 indataljud till engelsk text.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: flera delar/formulärdata

Svaren

Statuskod: 200

Beskrivning: OK

Exempel

Exempel

Hämtar engelskspråkig transkriberad text och associerade metadata från angivna talade 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"
  }
}

Exempel

Hämtar engelskspråkig transkriberad text och associerade metadata från angivna talade 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 med bilder från en texttext på en viss dall-e-modelldistribution

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Svaren

Statuskod: 200

Beskrivning: Ok

Statuskod: standard

Beskrivning: Ett fel uppstod.

Exempel

Exempel

Skapar avbildningar med en uppmaning.

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
          }
        }
      }
    ]
  }
}

Komponenter

felmeddelande

errorBase

fel

innerError

Inre fel med ytterligare information.

inreFelkod

Felkoder för det inre felobjektet.

Beskrivning: Felkoder för det inre felobjektet.

Typ: sträng

Standard:

Uppräkningsnamn: InnerErrorCode

Uppräkningsvärden:

dalleErrorResponse

dalleError

dalleInnerError

Inre fel med ytterligare information.

Resultat av Innehållsfilterbas

innehållsfilterallvarlighetsresultat

Resultat för innehållsfilter upptäckt

innehållsfilter upptäckt med citeringsresultat

Egenskaper för källhänvisning

Webbadress

license

innehållFilterResultatBas

Information om resultatet av innehållsfiltreringen.

innehållsfilterfrågeresultat

Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, 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 identifierats och om det har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.

resultatFörInnehållsfilterVal

Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om text från tredje part och svordomar, om den har identifierats och om den har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.

uppmaningsfilterresultat

Resultat av innehållsfiltrering för en enda fråga i begäran.

uppmaningsfilterresultat

Innehållsfiltreringsresultat för noll eller fler frågor i begäran. I en strömningsbegäran kan resultat för olika frågor komma vid olika tidpunkter eller i olika beställningar.

Inga egenskaper har definierats för den här komponenten.

dalle innehållsfilterresultat

Information om resultatet av innehållsfiltreringen.

dalleFilterresultat

Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, 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 identifierats och om det har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.

chatCompletionsRequestCommon

skapaFärdigställandebegäran

skapaSvarPåSlutförande

Representerar ett slutförandesvar från API:et. Obs! Både strömmade och icke-strömmade svarsobjekt har samma form (till skillnad från chattslutpunkten).

SkapaChattSlutförandeBegäran

chattavslutningsfunktioner

chattkompletteringsfunktionanropsalternativ

Om du anger en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.

förfrågningsmeddelande för chattkomplettering

Den här komponenten kan vara något av följande:

chattfärdiganmälningssystemmeddelande

chatSlutförandeFörfråganAnvändarMeddelande

MeddelandeFörAssistentFörSlutförandeAvChatt

Egenskaper för function_call

Argumenten

namn

chattkompletteringsförfrågningsverktygsmeddelande

chatCompletionRequestFunctionMessage

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

Den här komponenten kan vara något av följande:

chattSlutförandeBegäranAnvändarMeddelandeInnehållsDel

Den här komponenten kan vara något av följande:

chatkompletteringBegäranAssistentMeddelandeInnehållDel

Den här komponenten kan vara något av följande:

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

Den här komponenten kan vara något av följande:

meddelandeInnehållDelAvchattfullföljandeförfrågan

chatAvslutningsBegäranMeddelandeInnehållsDelBild

Egenskaper för image_url

URL

detalj

avslagPåChattSlutföringsFörfrågningsMeddelandeInnehållsDel

azurechattilläggskonfiguration

En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta används av en begäran om slutförande av chatten som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.

azureChatExtensionType

En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta används av en begäran om slutförande av chatten som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.

Beskrivning: En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta används av en begäran om slutförande av chatten som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen ä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 du använder det som ett Azure OpenAI-chatttillägg.

azureSökChattTilläggParametrar

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

Azure sökindex fältmappingsalternativ

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

azureSökfrågetyp

Den typ av Azure Search-hämtningsfråga som ska köras när du använder den som ett Azure OpenAI-chatttillägg.

Beskrivning: Den typ av Azure Search-hämtningsfråga som ska köras när du använder den som ett Azure OpenAI-chatttillägg.

Typ: sträng

Standard:

Uppräkningsnamn: AzureSearchQueryType

Uppräkningsvärden:

azureCosmosDBChatExtensionKonfiguration

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

azureCosmosDBChatExtensionParameters

Parametrar som ska användas när du konfigurerar Azure OpenAI På dina datachatttillägg när du använder Azure Cosmos DB för MongoDB vCore.

AlternativFörFältmappningIFörAzureCosmosDB

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

dinaDataAutentiseringsalternativ

Autentiseringsalternativen för Azure OpenAI på dina data.

dinDataAutentiseringstyp

De autentiseringstyper som stöds med Azure OpenAI på dina data.

Beskrivning: De autentiseringstyper som stöds med Azure OpenAI på dina data.

Typ: sträng

Standard:

Uppräkningsnamn: OnYourDataAuthenticationType

Uppräkningsvärden:

påDinaDataApiNyckelAutentiseringsAlternativ

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

påDinaDataAnslutningsSträngAutentiseringsAlternativ

Autentiseringsalternativen för Azure OpenAI På dina data när du använder en anslutningssträng.

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.

onYourDataUserAssignedManagedIdentityAuthenticationAlternativ

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

onDinDataVektoriseringKälla

En abstrakt representation av en vektoriseringskälla för Azure OpenAI På dina 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.

Beskrivning: Representerar tillgängliga källor som Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med
vektorsökning.

Typ: sträng

Standard:

Uppräkningsnamn: OnYourDataVectorizationSourceType

Uppräkningsvärden:

DistribueringNamnVectoriseringKälla

Information om en vektoriseringskälla som används av Azure OpenAI på dina data när du tillämpar vektorsökning, som baseras på ett internt namn på inbäddningsmodellens distributionsnamn i samma Azure OpenAI-resurs.

onYourDataEndpointVectoriseringKälla

Information om en vektoriseringskälla som används av Azure OpenAI På dina data när vektorsökning tillämpas, som baseras på ett offentligt Azure OpenAI-slutpunktsanrop för inbäddningar.

Azure-chatförlängningsmeddelandesammanhang

En representation av den ytterligare kontextinformation som är tillgänglig när Azure OpenAI-chatttillägg ingår i genereringen av ett motsvarande svar om chattens slutförande. Den här kontextinformationen fylls bara i när du använder en Azure OpenAI-begäran som konfigurerats för att använda ett matchande tillägg.

citat

källhänvisningsinformation för ett svarsmeddelande om att chatten har slutförts.

verktygsanrop för meddelandeavslutning

Egenskaper för funktionen

namn

Argumenten

verktygsanropstyp

Typ av verktygsanrop, i det här fallet function.

Beskrivning: Typ av verktygsanrop, i det här fallet function.

Typ: sträng

Standard:

Uppräkningsnamn: ToolCallType

Uppräkningsvärden:

chattavslutningsförfråganmeddelandeverktyg

chatCompletionRequestMessageFunction

createChatCompletionResponse (skapaChatCompletionRespons)

Representerar ett svar för chattens slutförande som returneras av modellen, baserat på de angivna indata.

createChatCompletionStreamResponse

Representerar en strömmad del av ett chattsvar som returneras av modellen, baserat på angivna indata.

chatCompletionStreamResponseDelta

Ett delta i chatten som genereras av strömmade modellsvar.

Egenskaper för function_call

Argumenten

namn

Meddelandeverktyg för chattfullständighetssamtalstycke

Egenskaper för funktionen

namn

Argumenten

alternativ för chattkompletteringström

Alternativ för strömningssvar. Ange endast detta när du anger stream: true.

chatCompletionChoiceLogProbs

Logga sannolikhetsinformation för valet.

chatCompletionTokenLogprob

chatslutförandemeddelande

Ett meddelande om att chatten har slutförts som genererats av modellen.

chattSlutförandeSvarMeddelandeRoll

Rollen som upphovsman till svarsmeddelandet.

Beskrivning: Rollen som upphovsman till svarsmeddelandet.

Typ: sträng

Standard:

Uppräkningsvärden:

• assistent

chatSlutförandeVerktygsValAlternativ

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

Den här komponenten kan vara något av följande:

chattkompletteringNamngavVerktygsalternativ

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

Egenskaper för funktionen

namn

ParallelToolCalls

Om du vill aktivera parallell funktionsanrop under verktygsanvändning.

Inga egenskaper har definierats för den här komponenten.

chattKompletteringsmeddelandeVerktygSamtal

Verktyget anropar som genereras av modellen, till exempel funktionsanrop.

Inga egenskaper har definierats för den här komponenten.

chattSlutförandeFunktionsAnrop

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

användning av slutföranden

Användningsstatistik för slutförandebegäran.

Egenskaper för completion_tokens_details

reasoning_tokens

Chattkompletteringsverktyg

Funktionsparametrar

Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet.

Om du utelämnar parameters definieras en funktion med en tom parameterlista.

Inga egenskaper har definierats för den här komponenten.

FunctionObject

ResponseFormatText

ResponseFormatJsonObject

ResponseFormatJsonSchemaSchema

Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt.

Inga egenskaper har definierats för den här komponenten.

ResponsformatJsonSchema

Egenskaper för json_schema

beskrivning

namn

Schemat

sträng

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 verbose_json

ljudresponsformat

Definierar formatet för utdata.

Beskrivning: Definierar formatet för utdata.

Typ: sträng

Standard:

Uppräkningsvärden:

• json
• texten
• srt
• verbose_json
• vtt

skapaTranskriberingsBegäran

Transkriptionsbegäran.

ljudsegment

Transkriptions- eller översättningssegment.

bildkvalitet

Kvaliteten på den bild som ska genereras.

Beskrivning: Kvaliteten på den bild som ska genereras.

Typ: sträng

Standard: standard

Uppräkningsnamn: Kvalitet

Uppräkningsvärden:

bilderSvarFormat

Formatet där de genererade bilderna returneras.

Beskrivning: Formatet där de genererade bilderna returneras.

Typ: sträng

Standard: url

Uppräkningsnamn: ImagesResponseFormat

Uppräkningsvärden:

bildstorlek

Storleken på de genererade bilderna.

Beskrivning: Storleken på de genererade bilderna.

Typ: sträng

Standard: 1024x1024

Uppräkningsnamn: Storlek

Uppräkningsvärden:

bildstil

Formatmallen för de genererade bilderna.

Beskrivning: Formatmallen för de genererade bilderna.

Typ: sträng

Standard: levande

Uppräkningsnamn: Formatmall

Uppräkningsvärden:

bildgenereringsförfrågan

skapaBildsvar

bildresultat

Bild-URL:en eller den kodade bilden om den lyckas och ett annat fel.

Tillägg för slutföranden

Tillägg för slutföranden är inte en del av den senaste GA-versionen av inferensspecifikationen för Azure OpenAI-dataplanet.

Chattmeddelande

Chattmeddelandeobjektet är inte en del av den senaste GA-versionen av inferensspecifikationen för Azure OpenAI-dataplanet.

Text till tal (förhandsversion)

Ingår för närvarande inte i den senaste Azure OpenAI GA-versionen av inferensspecifikationen för Azure OpenAI-dataplanet. Se den senaste förhandsversionen för den här funktionen.

Nästa steg

Lär dig mer om modeller och finjustering med REST-API:et. Läs mer om de underliggande modeller som driver Azure OpenAI.