Azure OpenAI in Microsoft Foundry Models REST API-referentie

Dit artikel geeft details over de inferentie REST API-eindpunten voor Azure OpenAI.

API-specificaties

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

• beheerlaag
• Datavlak - authoring
• Datavlak - inferentie

Elke API-oppervlakte/specificatie bevat een andere set Azure OpenAI-mogelijkheden. Elke API heeft zijn eigen unieke set preview- en stabiele/algemeen beschikbare (GA) API-releases. Preview-releases volgen momenteel meestal een maandelijkse cadens.

Authenticatie

Azure OpenAI biedt twee methoden voor authenticatie. Je kunt API Keys of Microsoft Entra ID gebruiken.

• API-sleutelauthenticatie: Voor dit type authenticatie moeten alle API-verzoeken de API-sleutel in de api-key HTTP-header bevatten. De Quickstart geeft instructies over hoe je met dit type authenticatie oproepen kunt voeren.

• Microsoft Entra ID authenticatie: Je kunt een API-aanroep authenticeren met een Microsoft Entra-token. Authenticatietokens worden opgenomen in een verzoek als header Authorization . Het gegeven token moet voorafgegaan worden door Bearer, bijvoorbeeld Bearer YOUR_AUTH_TOKEN. Je kunt onze handleiding lezen over authenticatie met Microsoft Entra ID.

REST API-versiebeheer

De service-API's zijn versiegevaagd met behulp van de api-version queryparameter. Alle versies volgen de YYYY-MM-DD datumstructuur. Voorbeeld:

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

Datavlak-inferentie

De rest van het artikel behandelt de GA-release van de Azure OpenAI data plane inference specification, 2024-10-21.

Als u op zoek bent naar documentatie over de nieuwste preview-API-release, raadpleegt u de meest recente api voor deductie van de preview-gegevenslaag.

Voltooiingen

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

Maakt een voltooiing aan voor de gegeven prompt, parameters en gekozen model.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Dienst niet beschikbaar

Voorbeelden

Voorbeeld

Maakt een voltooiing aan voor de gegeven prompt, parameters en 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
}

Reacties: 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
    }
  }
}

Embeddings

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

Verkrijg een vectorrepresentatie van een gegeven invoer die gemakkelijk kan worden gebruikt door machine learning-modellen en algoritmen.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Eigenschappen voor gebruik

prompt_tokens

total_tokens

Statuscode: 200

Beschrijving: OK

Voorbeelden

Voorbeeld

Geef de embeddings terug voor een gegeven prompt.

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

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

Reacties: 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
    }
  }
}

Chatfuncties voltooien

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

Maakt een voltooiing aan voor het chatbericht

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Dienst niet beschikbaar

Voorbeelden

Voorbeeld

Maakt een voltooiing aan voor de gegeven prompt, parameters en 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?"
  }
 ]
}

Reacties: 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

Maakt een voltooiing op basis van Azure Search-gegevens en 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"
    }
   }
  }
 ]
}

Reacties: 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

Maakt een voltooiing op basis van Azure Search vectorgegevens, een eerdere assistent-melding 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"
     ]
    }
   }
  }
 ]
}

Reacties: 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

Maakt een completion aan voor de meegeleverde 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"
     ]
    }
   }
  }
 ]
}

Reacties: 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 - Maak

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

Transcribeert audio naar de invoertaal.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: multipart/form-data

Responses

Statuscode: 200

Beschrijving: OK

Voorbeelden

Voorbeeld

Krijgt getranscribeerde tekst en bijbehorende metadata van de geleverde gesproken audiogegevens.

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

Reacties: Statuscode: 200

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

Voorbeeld

Krijgt getranscribeerde tekst en bijbehorende metadata van de geleverde 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--"

Reacties: Statuscode: 200

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

Vertalingen - Creatie

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

Transcribeert en vertaalt invoeraudio naar Engelse tekst.

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: multipart/form-data

Responses

Statuscode: 200

Beschrijving: OK

Voorbeelden

Voorbeeld

Krijgt Engelstalige getranscribeerde tekst en bijbehorende metadata van de aangeleverde 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--"

Reacties: Statuscode: 200

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

Voorbeeld

Krijgt Engelstalige getranscribeerde tekst en bijbehorende metadata van de aangeleverde 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--"

Reacties: Statuscode: 200

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

Afbeeldingen genereren

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

Genereert een batch afbeeldingen uit een tekstbijschrift bij een gegeven dall-e modelimplementatie

URI-parameters

Koptekst van aanvraag

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Voorbeelden

Voorbeeld

Maakt afbeeldingen aan die een prompt krijgen.

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

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

Components

errorResponse

errorBase

error

innerError

Interne fout met extra details.

innerErrorCode

Foutcodes voor het binnenste foutobject.

Beschrijving: Foutcodes voor het binnenste foutobject.

Type: tekenreeks

Standaard:

Naam: InnerErrorCode

Enum-waarden:

dalleErrorResponse

dalleError

dalleInnerError

Interne fout met extra details.

BasisVoorContentFilterResultaat

resultaat van ernst van inhoudsfiltering

Resultaat van gedetecteerde inhoudsfilter

inhoudsfilter gedetecteerd met citatieresultaat

Eigenschappen voor citatie

URL

licentie

inhoudFilterResultatenBasis

Informatie over de contentfilterresultaten.

contentFilterPromptResults

Informatie over de categorie content filtering (haat, seksueel, geweld, self_harm), of deze is gedetecteerd, evenals het ernstniveau (very_low, laag, middelgroot, op grote schaal die de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze gefilterd is of niet. Informatie over jailbreak-inhoud en vloeken, of het is gedetecteerd en of het gefilterd is of niet. En informatie over de klantbloklijst, of die gefilterd is en de identificatie ervan.

inhoudfilterKeuzeResultaten

Informatie over de categorie content filtering (haat, seksueel, geweld, self_harm), of deze is gedetecteerd, evenals het ernstniveau (very_low, laag, middelgroot, op grote schaal die de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze gefilterd is of niet. Informatie over tekst en vloekwoorden van derden, of het is gedetecteerd en of het gefilterd is of niet. En informatie over de klantbloklijst, of die gefilterd is en de identificatie ervan.

promptfilterresultaat

Contentfiltering resulteert voor één enkele prompt in het verzoek.

promptfilterresultaten

Contentfiltering resulteert voor nul of meer prompts in het verzoek. Bij een streamingverzoek kunnen resultaten voor verschillende prompts op verschillende tijdstippen of in verschillende volgorde binnenkomen.

Geen eigenschappen gedefinieerd voor deze component.

dalle-inhoudsfilterresultaten

Informatie over de contentfilterresultaten.

dalleFilterResults

Informatie over de categorie content filtering (haat, seksueel, geweld, self_harm), of deze is gedetecteerd, evenals het ernstniveau (very_low, laag, middelgroot, op grote schaal die de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze gefilterd is of niet. Informatie over jailbreak-inhoud en vloeken, of het is gedetecteerd en of het gefilterd is of niet. En informatie over de klantbloklijst, of die gefilterd is en de identificatie ervan.

chatVoltooiingsVerzoekAlgemeen

AanmakenVoltooiingsVerzoek

createCompletionResponse

Vertegenwoordigt een voltooiingsantwoord van de API. Let op: zowel de gestreamde als niet-gestreamde responsobjecten hebben dezelfde vorm (in tegenstelling tot het chat-eindpunt).

creëerChatVoltooiingsVerzoek

chatCompletionFunctions

chatVoltooiingFunctieaanroepOptie

Het specificeren van een bepaalde functie via {"name": "my_function"} dwingt het model om die functie aan te roepen.

chatVoltooingsverzoekBericht

Deze component kan een van de volgende zijn:

chatCompletionRequestSystemMessage

chatCompletionRequestUserMessage

chatCompletionRequestAssistantMessage

Eigenschappen voor function_call

arguments

naam

chatCompletionRequestToolMessage

chatCompletionRequestFunctionMessage

Onderdeel van chatpanelsysteemboodschapinhoud

Deze component kan een van de volgende zijn:

gedeelteVanGebruikersberichtVoorVoltooiingsVerzoekInChat

Deze component kan een van de volgende zijn:

BerichtinhoudgedeelteAssistentChatVoltooingsVerzoek

Deze component kan een van de volgende zijn:

Onderdeel van het berichtinhoudsaanvraaggereedschap voor chatvoltooiing

Deze component kan een van de volgende zijn:

chatVoltooiingsVerzoekBerichtInhoudDeelTekst

chatCompletionAanvraagBerichtInhoudDeelAfbeelding

Eigenschappen voor image_url

URL

detail

chatCompletionRequestMessageContentPartRefusal

azure-chatextensieconfiguratie

Een representatie van configuratiegegevens voor één enkele Azure OpenAI-chatextensie. Dit wordt gebruikt door een verzoek om chatvoltooiingen dat Azure OpenAI-chatextensies zou moeten gebruiken om het responsgedrag te versterken. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

azureChatExtensionType

Een representatie van configuratiegegevens voor één enkele Azure OpenAI-chatextensie. Dit wordt gebruikt door een verzoek om chatvoltooiingen dat Azure OpenAI-chatextensies zou moeten gebruiken om het responsgedrag te versterken. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

Beschrijving: Een representatie van configuratiegegevens voor één enkele Azure OpenAI-chatextensie. Dit wordt gebruikt door een verzoek om chatvoltooiingen dat Azure OpenAI-chatextensies zou moeten gebruiken om het responsgedrag te versterken. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

Type: tekenreeks

Standaard:

Enum Naam: AzureChatExtensionType

Enum-waarden:

azureSearchChatExtensionConfiguration

Een specifieke weergave van configureerbare opties voor Azure Search wanneer het wordt gebruikt als een Azure OpenAI chatextensie.

azureSearchChatExtensionParameters

Parameters voor Azure Search wanneer gebruikt als een Azure OpenAI chatextensie.

azureSearchIndexFieldMappingOptions

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

azureSearchQueryType

Het type Azure Search retrieval query dat uitgevoerd moet worden wanneer het wordt gebruikt als een Azure OpenAI chatextensie.

Beschrijving: Het type Azure Search retrieval query dat uitgevoerd moet worden wanneer het wordt 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 het wordt gebruikt als een Azure OpenAI chatextensie.

azureCosmosDBChatExtensionParameters

Parameters om te gebruiken bij het configureren van Azure OpenAI On Your Data chatextensies bij het 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-bron.

optiesVoorGegevensAuthenticatie

De authenticatieopties voor Azure OpenAI op uw gegevens.

uwDataAuthenticatietype

De authenticatietypen worden ondersteund met Azure OpenAI On Your Data.

Beschrijving: De authenticatietypen die worden ondersteund met Azure OpenAI On Your Data.

Type: tekenreeks

Standaard:

Naam: OnYourDataAuthenticationType

Enum-waarden:

opUwGegevensApiSleutelAuthenticatieOpties

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

onYourDataConnectionStringAuthenticatieOpties

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

Managed Identity Authenticatieopties toegewezen door uw DataSysteem

De authenticatieopties voor Azure OpenAI On Your Data wanneer je een systeem-toegewezen beheerde identiteit gebruikt.

onYourDataUserAssignedManagedIdentityAuthenticationOptions

De authenticatieopties voor Azure OpenAI On Your Data wanneer je een door de gebruiker toegewezen beheerde identiteit gebruikt.

OnUwDataVectorisatieBron

Een abstracte representatie van een vectorisatiebron voor Azure OpenAI On Your Data met vectorzoekopdracht.

onUwDataVectorisatieBronType

Geeft de beschikbare bronnen weer die Azure OpenAI On Your Data kan gebruiken om vectorisatie van data te configureren voor gebruik met vectorzoek.

Beschrijving: Geeft de beschikbare bronnen weer Azure OpenAI On Your Data kan gebruiken om vectorisatie van data te configureren voor gebruik met
vector zoeken.

Type: tekenreeks

Standaard:

Naam van het enum: OnYourDataVectorizationSourceType

Enum-waarden:

onUwDataDeploymentNaamVectorisatieBron

De details van een vectorisatiebron, gebruikt door Azure OpenAI On Your Data bij het toepassen van vectorzoekopdrachten, die gebaseerd is op een interne embeddingsmodel-implementatienaam in dezelfde Azure OpenAI-bron.

onYourDataEndpointVectorizationSource

De details van een vectorisatiebron, gebruikt door Azure OpenAI On Your Data bij het toepassen van vectorzoekopdrachten, die gebaseerd is op een publieke Azure OpenAI-endpointoproep voor embeddings.

azureChatExtensionsBerichtContext

Een representatie van de extra contextinformatie die beschikbaar is wanneer Azure OpenAI-chatextensies betrokken zijn bij het genereren van een bijbehorende chatvoltooiingsreactie. Deze contextinformatie wordt alleen ingevuld wanneer een Azure OpenAI-verzoek wordt gebruikt dat is geconfigureerd om een bijpassende extensie te gebruiken.

Citaat

Citatie-informatie voor een chat-complete-antwoordbericht.

Chatvoltooiingsberichthulproep

Eigenschappen voor functie

naam

arguments

toolCallType

Het type gereedschapsoproep, in dit geval function.

Beschrijving: Het type gereedschapsoproep, in dit geval function.

Type: tekenreeks

Standaard:

Naam: ToolCallType

Enum-waarden:

chatVoltooiingsAanvraagBerichtTool

chatCompletionRequestMessageFunction

createChatCompletionResponse

Vertegenwoordigt een chatvoltooiingsantwoord dat door het model wordt teruggegeven, gebaseerd op de gegeven invoer.

createChatCompletionStreamResponse

Vertegenwoordigt een gestreamd stuk van een chatvoltooiingsantwoord dat door het model wordt teruggegeven, gebaseerd op de gegeven input.

chatCompletionStreamResponseDelta

Een chatvoltooiingsdelta gegenereerd door gestreamde modelreacties.

Eigenschappen voor function_call

arguments

naam

chatVoltooingsBerichtToolOproepStuk

Eigenschappen voor functie

naam

arguments

chatCompletionStreamOptions

Opties voor streaming response. Stel dit alleen in wanneer je stream: true.

chatCompletionChoiceLogProbs (logaritmische waarschijnlijkheden van chatvoltooiingskeuzes)

Log waarschijnlijkheidsinformatie voor de keuze.

chatCompletionTokenLogprob

chatAfwerkingReactieBericht

Een bericht over het voltooien van de chat dat door het model wordt gegenereerd.

chatCompletionResponseMessageRole

De rol van de auteur van het antwoordbericht.

Beschrijving: De rol van de auteur van het antwoordbericht.

Type: tekenreeks

Standaard:

Enum-waarden:

• Assistent

chatCompletionToolChoiceOption

Bepaalt welk (indien aanwezig) gereedschap door het model wordt aangeroepen. none betekent dat het model geen tool aanroept maar 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 tools. required betekent dat het model één of meer tools moet aanroepen. Het specificeren van een bepaald hulpmiddel via {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpmiddel aan te roepen. none is de standaard wanneer er geen gereedschap aanwezig is. auto is de standaard als er tools aanwezig zijn.

Deze component kan een van de volgende zijn:

chatCompletionNamedToolChoice

Specificeert een tool die het model moet gebruiken. Gebruik om het model te dwingen een specifieke functie aan te roepen.

Eigenschappen voor functie

naam

ParallelToolCalls

Of parallelle functieaanroep tijdens het gebruik van het gereedschap moet worden ingeschakeld.

Geen eigenschappen gedefinieerd voor deze component.

chatCompletionMessageToolCalls

De toolaanroepen die door het model worden gegenereerd, zoals functieaanroepen.

Geen eigenschappen gedefinieerd voor deze component.

chatCompletionFunctionCall

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

voltooiingsgebruik

Gebruiksstatistieken voor het voltooiingsverzoek.

Eigenschappen voor completion_tokens_details

redeneringssymbolen

chatvoltooiingshulpmiddel

FunctionParameters

De parameters die de functie accepteert, worden beschreven als een JSON Schema-object. Zie de gids voor voorbeelden en de JSON Schema-referentie voor documentatie over het formaat.

Weglaten parameters definieert een functie met een lege parameterlijst.

Geen eigenschappen gedefinieerd voor deze component.

FunctionObject

AntwoordFormaatTekst

ResponseFormatJsonObject

ReactieformaatJsonSchemaSchema

Het schema voor het responsformaat, beschreven als een JSON Schema-object.

Geen eigenschappen gedefinieerd voor deze component.

ResponseFormatJsonSchema

Eigenschappen voor json_schema

description

naam

schema

streng

keuzeGesprekVoltooiingGemeenschappelijk

VertaalaanvraagAanmaken

Vertaalaanvraag.

audioantwoord

Vertaling of transcriptierespons wanneer response_format JSON was

audioVerboseResponse

Vertaling of transcriptierespons wanneer response_format verbose_json

audioResponseFormat

Definieert het formaat van de uitvoer.

Beschrijving: Definieert het formaat van de uitvoer.

Type: tekenreeks

Standaard:

Enum-waarden:

• json
• tekst
• srt
• verbose_json
• vtt

maakTranscriptieVerzoek

Transcriptieaanvraag.

audiogedeelte

Transcriptie- of vertaalsegment.

imageQuality

De kwaliteit van de afbeelding die wordt gegenereerd.

Beschrijving: De kwaliteit van de afbeelding die wordt gegenereerd.

Type: tekenreeks

Standaard: standaard

Enum Naam: Kwaliteit

Enum-waarden:

imagesResponseFormat

Het formaat waarin de gegenereerde afbeeldingen worden teruggegeven.

Beschrijving: Het formaat waarin de gegenereerde afbeeldingen worden teruggestuurd.

Type: tekenreeks

Standaard: URL

Naam: ImagesResponseFormat

Enum-waarden:

imageSize

De grootte van de gegenereerde afbeeldingen.

Beschrijving: De grootte van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: 1024x1024

Enum Naam: Grootte

Enum-waarden:

imageStyle

De stijl van de gegenereerde afbeeldingen.

Beschrijving: De stijl van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: levendig

Enum Naam: Stijl

Enum-waarden:

verzoek om afbeeldingsgeneraties

generateImagesResponse

beeldresultaat

De afbeeldings-url of gecodeerde afbeelding als het lukt, en een foutmelding anders.

Uitbreidingen voor voltooiingen

Completions-extensies maken geen deel uit van de nieuwste GA-versie van de Azure OpenAI data plane inference spec.

Chatbericht

Het Chat-berichtobject maakt geen deel uit van de nieuwste GA-versie van de Azure OpenAI data plane inference spec.

Tekst-naar-spraak (Preview)

Maakt momenteel geen deel uit van de nieuwste Azure OpenAI GA-versie van de Azure OpenAI dataplane inference spec. Raadpleeg de nieuwste versie van preview voor deze functionaliteit.

Volgende stappen 

Leer over modellen en fijn afstemmen met de REST API. Meer informatie over de onderliggende modellen die gebruikmaken van Azure OpenAI.