Naslaginformatie over "Azure OpenAI" in "Azure AI Foundry Models" REST API-referentie

Dit artikel bevat informatie over de REST API-eindpunten voor deductie voor Azure OpenAI.

API-specificaties

Het beheren en communiceren met Azure OpenAI-modellen en -resources is verdeeld over drie primaire API-oppervlakken:

• beheerlaag
• Gegevensvlak - ontwerpen
• Gegevensvlak - deductie

Elke API-surface/-specificatie bevat een andere set Azure OpenAI-mogelijkheden. Elke API heeft een eigen unieke set preview-versies en stabiele/algemeen beschikbare API-releases. Preview-versies volgen momenteel meestal een maandelijkse frequentie.

Authenticatie

Azure OpenAI biedt twee methoden voor verificatie. U kunt API-sleutels of Microsoft Entra-id gebruiken.

• API-sleutelverificatie: voor dit type verificatie moeten alle API-aanvragen de API-sleutel in de api-key HTTP-header bevatten. De quickstart bevat richtlijnen voor het maken van aanroepen met dit type verificatie.

• Microsoft Entra ID-verificatie: u kunt een API-aanroep verifiëren met behulp van een Microsoft Entra-token. Verificatietokens worden als header Authorization opgenomen in een aanvraag. Het opgegeven token moet worden voorafgegaan door Bearerbijvoorbeeld Bearer YOUR_AUTH_TOKEN. U kunt onze handleiding voor verificatie met Microsoft Entra ID lezen.

REST API-versiebeheer

De service-API's hebben versiebeheer met behulp van de api-version queryparameter. Alle versies volgen de datumstructuur JJJJ-MM-DD. Voorbeeld:

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

Deductie van het gegevensvlak

De rest van het artikel bevat informatie over de nieuwste GA-release van de Azure OpenAI-gegevensvlakdeductiespecificatie, 2024-10-21.

Als u op zoek bent naar documentatie over de nieuwste preview-API-release, raadpleegt u de nieuwste preview-API voor deductie-API voor gegevensvlakken

Voltooiingen

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

Hiermee maakt u een voltooiing voor de opgegeven prompt, parameters en het gekozen model.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Reacties

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Voorbeelden

Voorbeeld

Hiermee maakt u een voltooiing voor de opgegeven prompt, parameters en het gekozen model.

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
}

Antwoorden: Statuscode: 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
    }
  }
}

Embedderingen

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

Haal een vectorweergave op van een bepaalde invoer die eenvoudig kan worden gebruikt door machine learning-modellen en -algoritmen.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Reacties

Eigenschappen voor gebruik

prompt_tokens

totaal_tokens

Statuscode: 200

Beschrijving: OK

Voorbeelden

Voorbeeld

Retourneer de insluitingen voor een bepaalde prompt.

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

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

Antwoorden: Statuscode: 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
    }
  }
}

Chatresultaten

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

Hiermee maakt u een voltooiing voor het chatbericht

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Reacties

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Voorbeelden

Voorbeeld

Hiermee maakt u een voltooiing voor de opgegeven prompt, parameters en het gekozen model.

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

Antwoorden: Statuscode: 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
    }
  }
}

Voorbeeld

Hiermee maakt u een voltooiing op basis van Azure Search-gegevens en door het systeem toegewezen beheerde identiteit.

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

Antwoorden: Statuscode: 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
    }
  }
}

Voorbeeld

Hiermee maakt u een voltooiing op basis van Azure Search-vectorgegevens, vorige assistentbericht en door de gebruiker toegewezen beheerde identiteit.

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

Antwoorden: Statuscode: 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
    }
  }
}

Voorbeeld

Hiermee maakt u een voltooiing voor de opgegeven 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"
     ]
    }
   }
  }
 ]
}

Antwoorden: Statuscode: 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
    }
  }
}

Transcripties - Maken

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

Hiermee wordt audio getranscribeerd in de invoertaal.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: multipart/form-data

Reacties

Statuscode: 200

Beschrijving: OK

Voorbeelden

Voorbeeld

Hiermee haalt u getranscribeerde tekst en bijbehorende metagegevens op uit de verstrekte gesproken audiogegevens.

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

Antwoorden: Statuscode: 200

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

Voorbeeld

Hiermee haalt u getranscribeerde tekst en bijbehorende metagegevens op uit de verstrekte gesproken audiogegevens.

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--"

Antwoorden: Statuscode: 200

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

Vertalingen - Maken

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

Hiermee wordt invoeraudio getranscribeerd en omgezet in Engelse tekst.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: multipart/form-data

Reacties

Statuscode: 200

Beschrijving: OK

Voorbeelden

Voorbeeld

Hiermee haalt u getranscribeerde engelse tekst en bijbehorende metagegevens op van opgegeven gesproken audiogegevens.

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--"

Antwoorden: Statuscode: 200

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

Voorbeeld

Hiermee haalt u getranscribeerde engelse tekst en bijbehorende metagegevens op van opgegeven gesproken audiogegevens.

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--"

Antwoorden: Statuscode: 200

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

Afbeeldingsgeneratie

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

Hiermee wordt een batch afbeeldingen gegenereerd op basis van een tekstbijschrift voor een bepaalde dall-e-modelimplementatie

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Reacties

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Voorbeelden

Voorbeeld

Hiermee maakt u installatiekopieën op basis van een 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"
}

Antwoorden: Statuscode: 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
          }
        }
      }
    ]
  }
}

Onderdeel

foutreactie

errorBase

fout

interne fout

Interne fout met aanvullende details.

innerErrorCode

Foutcodes voor het binnenste foutobject.

Beschrijving: Foutcodes voor het binnenste foutobject.

Type: tekenreeks

Standaard:

Opsommingsnaam: InnerErrorCode

Enum-waarden:

dalleErrorResponse

dalleError

dalleInnerError

Interne fout met aanvullende details.

BasisVoorContentFilterResultaat

resultaat van ernst van inhoudsfiltering

Resultaat van gedetecteerde inhoudsfilter

inhoudsfilter gedetecteerd met citatieresultaat

Eigenschappen voor bronvermelding

URL

licentie

inhoudFilterResultatenBasis

Informatie over de resultaten van het filteren van inhoud.

contentFilterPromptResultaten

Informatie over de inhoudsfiltercategorie (haat, seksueel, geweld, self_harm), als deze is gedetecteerd, evenals het ernstniveau (very_low, laag, gemiddeld, hoogschalig dat de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze is gefilterd of niet. Informatie over jailbreak-inhoud en grof taalgebruik, als deze is gedetecteerd en of deze is gefilterd of niet. En informatie over de blokkeringslijst van klanten, als deze is gefilterd en de bijbehorende id.

inhoudfilterKeuzeResultaten

Informatie over de inhoudsfiltercategorie (haat, seksueel, geweld, self_harm), als deze is gedetecteerd, evenals het ernstniveau (very_low, laag, gemiddeld, hoogschalig dat de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze is gefilterd of niet. Informatie over tekst van derden en grof taalgebruik, als deze is gedetecteerd en of deze is gefilterd of niet. En informatie over de blokkeringslijst van klanten, als deze is gefilterd en de bijbehorende id.

promptfilterresultaat

Resultaten van het filteren van inhoud voor één prompt in de aanvraag.

promptfilterresultaten

Resultaten van het filteren van inhoud voor nul of meer prompts in de aanvraag. In een streamingaanvraag kunnen de resultaten voor verschillende prompts op verschillende tijdstippen of in verschillende orders binnenkomen.

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

dalle-inhoudsfilterresultaten

Informatie over de resultaten van het filteren van inhoud.

dalleFilterResultaten

Informatie over de inhoudsfiltercategorie (haat, seksueel, geweld, self_harm), als deze is gedetecteerd, evenals het ernstniveau (very_low, laag, gemiddeld, hoogschalig dat de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze is gefilterd of niet. Informatie over jailbreak-inhoud en grof taalgebruik, als deze is gedetecteerd en of deze is gefilterd of niet. En informatie over de blokkeringslijst van klanten, als deze is gefilterd en de bijbehorende id.

chatVoltooiingsVerzoekAlgemeen

AanmakenVoltooiingsVerzoek

creëerVoltooiingsAntwoord

Vertegenwoordigt een voltooiingsantwoord van de API. Opmerking: zowel de gestreamde als niet-gestreamde antwoordobjecten delen dezelfde vorm (in tegenstelling tot het chateindpunt).

creëerChatVoltooiingsVerzoek

chatCompletionFunctions

chatVoltooiingFunctieaanroepOptie

Als u een bepaalde functie opgeeft via dwingt {"name": "my_function"} u het model om die functie aan te roepen.

chatVoltooingsverzoekBericht

Dit onderdeel kan een van de volgende zijn:

Sys­teem­bericht voor chat­vol­tooi­ing­ver­zoek

chatVoltooiingVerzoekGebruikersBericht

Aanvraag voor Voltooiing Assistent Chat

Eigenschappen voor function_call

Argumenten

naam

chatVoltooiingsVerzoekToolBericht

chatCompletionRequestFunctionMessage

Onderdeel van chatpanelsysteemboodschapinhoud

Dit onderdeel kan een van de volgende zijn:

gedeelteVanGebruikersberichtVoorVoltooiingsVerzoekInChat

Dit onderdeel kan een van de volgende zijn:

BerichtinhoudgedeelteAssistentChatVoltooingsVerzoek

Dit onderdeel kan een van de volgende zijn:

Onderdeel van het berichtinhoudsaanvraaggereedschap voor chatvoltooiing

Dit onderdeel kan een van de volgende zijn:

chatVoltooiingsVerzoekBerichtInhoudDeelTekst

chatCompletionAanvraagBerichtInhoudDeelAfbeelding

Eigenschappen voor image_url

URL

beschrijving

afwijzing van chat afrondingsaanvraagberichtinhouddeel

azure-chatextensieconfiguratie

Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een aanvraag voor het voltooien van chats die azure OpenAI-chatextensies moeten gebruiken om het reactiegedrag te verbeteren. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

azureChatExtensionType

Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een aanvraag voor het voltooien van chats die azure OpenAI-chatextensies moeten gebruiken om het reactiegedrag te verbeteren. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

Beschrijving: Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een aanvraag voor het voltooien van chats die azure OpenAI-chatextensies moeten gebruiken om het reactiegedrag te verbeteren. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

Type: tekenreeks

Standaard:

Enum-naam: AzureChatExtensionType

Enum-waarden:

azureSearchChatExtensieConfiguratie

Een specifieke weergave van configureerbare opties voor Azure Search wanneer u deze gebruikt als een Azure OpenAI-chatextensie.

Azure-zoek-chatuitbreidingsparameters

Parameters voor Azure Search wanneer deze worden gebruikt als een Azure OpenAI-chatextensie.

azureSearchIndexVeldtoewijzingsopties

Optionele instellingen om te bepalen hoe velden worden verwerkt bij het gebruik van een geconfigureerde Azure Search-resource.

Azure Zoekopdracht Type

Het type Azure Search-ophaalquery dat moet worden uitgevoerd wanneer u deze gebruikt als een Azure OpenAI-chatextensie.

Beschrijving: Het type Azure Search-ophaalquery dat moet worden uitgevoerd wanneer u deze gebruikt als een Azure OpenAI-chatextensie.

Type: tekenreeks

Standaard:

Enum-naam: AzureSearchQueryType

Enum-waarden:

azureCosmosDBChatExtensionConfiguration

Een specifieke weergave van configureerbare opties voor Azure Cosmos DB wanneer u deze gebruikt als een Azure OpenAI-chatextensie.

azureCosmosDBChatExtensieParameters

Parameters die moeten worden gebruikt bij het configureren van Azure OpenAI op uw gegevenschatextensies bij gebruik van Azure Cosmos DB voor MongoDB vCore.

azureCosmosDBFieldMappingOptions

Optionele instellingen om te bepalen hoe velden worden verwerkt bij het gebruik van een geconfigureerde Azure Cosmos DB-resource.

optiesVoorGegevensAuthenticatie

De verificatieopties voor Azure OpenAI op uw gegevens.

UwGegevensAuthenticatieType

De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens.

Beschrijving: De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens.

Type: tekenreeks

Standaard:

Enum-naam: OnYourDataAuthenticationType

Enum-waarden:

onYourDataApiKeyAuthenticatieOpties

De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een API-sleutel gebruikt.

onUwDataVerbindingsreeksAuthenticatieopties

De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een verbindingsreeks gebruikt.

Managed Identity Authenticatieopties toegewezen door uw DataSysteem

De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een door het systeem toegewezen beheerde identiteit gebruikt.

Gebruiker Toegewezen Beheerde Identiteit Authenticatie Opties

De verificatieopties voor Azure OpenAI op uw gegevens bij gebruik van een door de gebruiker toegewezen beheerde identiteit.

OnUwDataVectorisatieBron

Een abstracte weergave van een vectorisatiebron voor Azure OpenAI On Your Data met vectorzoekopdrachten.

onUwDataVectorisatieBronType

Vertegenwoordigt de beschikbare bronnen die Azure OpenAI op uw gegevens kan gebruiken om vectorisatie van gegevens te configureren voor gebruik met vectorzoekopdrachten.

Beschrijving: Vertegenwoordigt de beschikbare bronnen die Azure OpenAI op uw gegevens kunnen gebruiken om vectorisatie van gegevens te configureren voor gebruik met
vector zoeken.

Type: tekenreeks

Standaard:

Enum-naam: OnYourDataVectorizationSourceType

Enum-waarden:

onUwDataDeploymentNaamVectorisatieBron

De details van een vectorisatiebron, die wordt gebruikt door Azure OpenAI Op uw gegevens bij het toepassen van vectorzoekopdrachten, die is gebaseerd op een interne naam voor het implementeren van een model voor insluitingen in dezelfde Azure OpenAI-resource.

onYourDataEndpointVectorizationSource

De details van een vectorisatiebron, die door Azure OpenAI op uw gegevens worden gebruikt bij het toepassen van vectorzoekopdrachten, die is gebaseerd op een openbare Aanroep van een Azure OpenAI-eindpunt voor insluitingen.

azureChatExtensionsBerichtContext

Een weergave van de aanvullende contextinformatie die beschikbaar is wanneer Azure OpenAI-chatextensies betrokken zijn bij het genereren van een overeenkomstig chatvoltooiingsantwoord. Deze contextinformatie wordt alleen ingevuld wanneer u een Azure OpenAI-aanvraag gebruikt die is geconfigureerd voor het gebruik van een overeenkomende extensie.

citaat

Bronvermeldingsinformatie voor een antwoordbericht over het voltooien van een chat.

Chatvoltooiingsberichthulproep

Eigenschappen voor functie

naam

Argumenten

hulpprogrammaoproepType

Het type van de aanroep van het hulpprogramma, in dit geval function.

Beschrijving: Het type van de aanroep van het hulpprogramma, in dit geval function.

Type: tekenreeks

Standaard:

Opsommingsnaam: ToolCallType

Enum-waarden:

chatVoltooiingsAanvraagBerichtTool

chatCompletionRequestMessageFunction

createChatCompletionResponse

Vertegenwoordigt een antwoord op voltooiing van een chat dat wordt geretourneerd door het model, op basis van de opgegeven invoer.

createChatCompletionStreamResponse

Vertegenwoordigt een gestreamd segment van een antwoord op voltooiing van een chat dat door het model wordt geretourneerd, op basis van de opgegeven invoer.

chatCompletionStreamResponseDelta

Een delta voor het voltooien van chats die wordt gegenereerd door gestreamde modelreacties.

Eigenschappen voor function_call

Argumenten

naam

chatVoltooingsBerichtToolOproepStuk

Eigenschappen voor functie

naam

Argumenten

chat voltooiingsstroomopties

Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt stream: true.

chatCompletionChoiceLogProbs (logaritmische waarschijnlijkheden van chatvoltooiingskeuzes)

Logboekinformatie over waarschijnlijkheid voor de keuze.

chatCompletionTokenLogprob

chatAfwerkingReactieBericht

Een chatvoltooiingsbericht gegenereerd door het model.

RolVanHetAntwoordberichtBijChatVoltooiing

De rol van de auteur van het antwoordbericht.

Beschrijving: De rol van de auteur van het antwoordbericht.

Type: tekenreeks

Standaard:

Enum-waarden:

• assistent

optie voor het kiezen van het tool voor chataanvulling

Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. none betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. auto betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. required betekent dat het model een of meer hulpprogramma's moet aanroepen. Het opgeven van een bepaald hulpprogramma via {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpprogramma aan te roepen. none is de standaardinstelling wanneer er geen hulpprogramma's aanwezig zijn. auto is de standaardinstelling als er hulpprogramma's aanwezig zijn.

Dit onderdeel kan een van de volgende zijn:

chatVoltooiingGenoemdToolKeuze

Hiermee geeft u een hulpprogramma op dat het model moet gebruiken. Gebruik dit om het model te dwingen een specifieke functie aan te roepen.

Eigenschappen voor functie

naam

ParallelToolCalls

Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma.

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

chatCompletionBerichtGereedschapOproepen

De hulpprogramma-aanroepen die door het model worden gegenereerd, zoals functie-aanroepen.

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

chatVoltooiingsFunctieAanroep

Afgeschaft en vervangen door tool_calls. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.

voltooiingsgebruik

Gebruiksstatistieken voor de voltooiingsaanvraag.

Eigenschappen voor completion_tokens_details

redeneringssymbolen

chatvoltooiingshulpmiddel

FunctionParameters

De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject. Zie de handleiding voor voorbeelden en de naslaginformatie over het JSON-schema voor documentatie over de indeling.

Als u parameters weglaat, wordt een functie met een lege parameterlijst gedefinieerd.

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

FunctionObject

AntwoordFormaatTekst

ResponseFormatJsonObject

ReactieformaatJsonSchemaSchema

Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject.

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

ResponseFormatJsonSchema

Eigenschappen voor json_schema

beschrijving

naam

overzicht

streng

keuzeGesprekVoltooiingGemeenschappelijk

VertaalaanvraagAanmaken

Vertaalaanvraag.

audioantwoord

Vertaling of transcriptiereactie toen response_format json was

audioVerboseResponse

Vertaling of transcriptiereactie toen response_format werd verbose_json

audioantwoordformaat

Hiermee definieert u de indeling van de uitvoer.

Beschrijving: Definieert de indeling van de uitvoer.

Type: tekenreeks

Standaard:

Enum-waarden:

• json
• Tekst
• srt
• verbose_json
• vtt

maakTranscriptieVerzoek

Transcriptieaanvraag.

audiogedeelte

Transcriptie- of vertaalsegment.

beeldkwaliteit

De kwaliteit van de afbeelding die wordt gegenereerd.

Beschrijving: De kwaliteit van de afbeelding die wordt gegenereerd.

Type: tekenreeks

Standaard: standaard

Naam van opsomming: kwaliteit

Enum-waarden:

afbeeldingenantwoordformaat

De indeling waarin de gegenereerde afbeeldingen worden geretourneerd.

Beschrijving: De indeling waarin de gegenereerde afbeeldingen worden geretourneerd.

Type: tekenreeks

Standaard: URL

Enum-naam: ImagesResponseFormat

Enum-waarden:

afbeeldingsgrootte

De grootte van de gegenereerde afbeeldingen.

Beschrijving: De grootte van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: 1024x1024

Naam van opsomming: grootte

Enum-waarden:

beeldstijl

De stijl van de gegenereerde afbeeldingen.

Beschrijving: De stijl van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: levendig

Naam van opsomming: stijl

Enum-waarden:

verzoek om afbeeldingsgeneraties

generateImagesResponse

beeldresultaat

De afbeeldings-URL of gecodeerde installatiekopieën, indien geslaagd, en anders een fout.

Uitbreidingen voor voltooiingen

Voltooiingsextensies maken geen deel uit van de nieuwste GA-versie van de azure OpenAI-gegevensvlakdeductiespecificatie.

Chatbericht

Het chatberichtobject maakt geen deel uit van de nieuwste GA-versie van de azure OpenAI-gegevensvlakdeductiespecificatie.

Tekst naar spraak (voorbeeldweergave)

Maakt momenteel geen deel uit van de nieuwste Azure OpenAI GA-versie van de azure OpenAI-gegevensvlakdeductiespecificatie. Raadpleeg de nieuwste preview-versie voor deze mogelijkheid.

Volgende stappen

Meer informatie over modellen en het afstemmen met de REST API. Meer informatie over de onderliggende modellen die Azure OpenAI mogelijk maken.