Azure OpenAI dans Microsoft Foundry Models référence REST API

Cet article fournit des détails sur les terminaux d’inférence de l’API REST pour Azure OpenAI.

Spécifications de l’API

La gestion et l’interaction avec les modèles et ressources OpenAI Azure sont réparties sur trois surfaces principales d’API :

• Plan de contrôle
• Plan de données - création
• Plan de données - inférence

Chaque surface/spécification API englobe un ensemble différent de capacités Azure OpenAI. Chaque API possède son propre ensemble unique de versions d’aperçu et d’API stable/généralement disponibles (GA). Les sorties de prévisualisation suivent actuellement un rythme mensuel.

Authentication

Azure OpenAI propose deux méthodes d’authentification. Vous pouvez utiliser soit API Keys, soit Microsoft Entra ID.

• Authentification par clé API : Pour ce type d’authentification, toutes les requêtes API doivent inclure la clé API dans l’en-tête api-key HTTP. Le Quickstart fournit des conseils pour passer des appels avec ce type d’authentification.

• Microsoft Entra ID : Vous pouvez authentifier un appel API à l’aide d’un jeton Microsoft Entra. Les jetons d’authentification sont inclus dans une requête en tant qu’en-tête Authorization . Le jeton fourni doit être précédé de Bearer, par exemple Bearer YOUR_AUTH_TOKEN. Vous pouvez lire notre guide pratique sur authentifier avec Microsoft Entra ID.

Versionnement de l’API REST

Les API de service sont versionnées à l’aide du api-version paramètre de requête. Toutes les versions suivent la structure de dates YYYY-MM-DD. Par exemple:

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

Inférence dans les plans de données

Le reste de l’article traite de la version GA de la spécification d’inférence du plan de données OpenAI .

Si vous recherchez de la documentation sur la dernière version de l’API en préversion, reportez-vous à la dernière API d’inférence du plan de données en préversion.

Achèvements

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

Crée une complétion pour l’invite fournie, les paramètres et le modèle choisi.

Paramètres d’URI

En-tête de requête

Corps de la requête

Content-Type : application/json

Responses

Code de statut : 200

Description : OK

Code de statut : par défaut

Description : Service indisponible

Exemples

Example

Crée une complétion pour l’invite fournie, les paramètres et le modèle choisi.

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
}

Réponses : Code de statut : 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

Obtenez une représentation vectorielle d’une entrée donnée qui peut être facilement consommée par des modèles et algorithmes d’apprentissage automatique.

Paramètres d’URI

En-tête de requête

Corps de la requête

Content-Type : application/json

Responses

Propriétés d’utilisation

prompt_tokens

total_tokens

Code de statut : 200

Description : OK

Exemples

Example

Retournez les embeddings pour une invite donnée.

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

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

Réponses : Code de statut : 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
    }
  }
}

Finalisation de la conversation

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

Crée une complétion pour le message de chat

Paramètres d’URI

En-tête de requête

Corps de la requête

Content-Type : application/json

Responses

Code de statut : 200

Description : OK

Code de statut : par défaut

Description : Service indisponible

Exemples

Example

Crée une complétion pour l’invite fournie, les paramètres et le modèle choisi.

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

Réponses : Code de statut : 200

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

Example

Crée une complétion basée sur les données Azure Search et l’identité managée assignée au système.

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

Réponses : Code de statut : 200

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

Example

Crée une complétion basée sur les données du vecteur de recherche Azure, le message d’assistant précédent et l’identité gérée attribuée par l’utilisateur.

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

Réponses : Code de statut : 200

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

Example

Crée une complétion pour la Azure Cosmos DB fournie.

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

Réponses : Code de statut : 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
    }
  }
}

Transcriptions - Créer

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

Transcrit l’audio dans la langue d’entrée.

Paramètres d’URI

En-tête de requête

Corps de la requête

Content-Type : multipart/form-data

Responses

Code de statut : 200

Description : OK

Exemples

Example

Obtient le texte transcrit et les métadonnées associées à partir des données audio parlées fournies.

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

Réponses : Code de statut : 200

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

Example

Obtient le texte transcrit et les métadonnées associées à partir des données audio parlées fournies.

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

Réponses : Code de statut : 200

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

Traductions - Create

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

Transcrit et traduit l’audio d’entrée en texte anglais.

Paramètres d’URI

En-tête de requête

Corps de la requête

Content-Type : multipart/form-data

Responses

Code de statut : 200

Description : OK

Exemples

Example

Obtient le texte transcrit en anglais et les métadonnées associées à partir des données audio parlées fournies.

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

Réponses : Code de statut : 200

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

Example

Obtient le texte transcrit en anglais et les métadonnées associées à partir des données audio parlées fournies.

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

Réponses : Code de statut : 200

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

Génération d'image

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

Génère un lot d’images à partir d’une légende texte sur un déploiement donné du modèle dall-e

Paramètres d’URI

En-tête de requête

Corps de la requête

Content-Type : application/json

Responses

Code de statut : 200

Description : Ok

Code de statut : par défaut

Description : Une erreur s’est produite.

Exemples

Example

Crée des images à partir d’une invitation.

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

Réponses : Code de statut : 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
          }
        }
      }
    ]
  }
}

Composants

errorResponse

errorBase

erreur

innerError

Erreur intérieure avec des détails supplémentaires.

innerErrorCode

Codes d’erreur pour l’objet d’erreur interne.

Description : Codes d’erreur pour l’objet d’erreur interne.

Type : chaîne

Valeur par défaut :

Nom d’enum : InnerErrorCode

Valeurs d’énumération :

dalleErrorResponse

dalleError

dalleInnerError

Erreur intérieure avec des détails supplémentaires.

BaseDeRésultatDeFiltreDeContenu

Résultat de la sévérité du filtre de contenu

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

Propriétés de citation

URL

license

contentFilterResultsBase

Informations sur les résultats du filtrage de contenu.

contentFilterPromptResults

Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.

contentFilterChoiceResults

Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur les textes et jurons tiers, si cela a été détecté, et s’il a été filtré ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.

promptFilterResult

Résultats de filtrage de contenu pour une seule invite dans la requête.

promptFilterResults

Filtrage de contenu pour zéro ou plus d’invites dans la requête. Dans une requête en streaming, les résultats pour différentes invitations peuvent arriver à des moments ou dans des ordres différents.

Aucune propriété définie pour ce composant.

RésultatsDalleFiltreDeContenu

Informations sur les résultats du filtrage de contenu.

dalleFilterResults

Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.

chatCompletionsRequestCommon

créerDemandeDeComplétion

createCompletionResponse

Représente une réponse de complétion de l’API. Note : les objets de réponse en streaming et non diffusés partagent la même forme (contrairement au point d’extrémité du chat).

createChatCompletionRequest

chatCompletionFunctions

chatCompletionFunctionCallOption

Spécifier une fonction particulière via {"name": "my_function"} force le modèle à appeler cette fonction.

chatCompletionRequestMessage

Ce composant peut être l’un des suivants :

Message du système de demande d'achèvement du chat

chatCompletionRequestUserMessage

chatCompletionRequestAssistantMessage

Propriétés pour function_call

Arguments

name

chatCompletionRequestToolMessage

chatCompletionRequestFunctionMessage

Partie de contenu du message système de requête de finalisation de chat

Ce composant peut être l’un des suivants :

chatCompletionRequestUserMessageContentPart

Ce composant peut être l’un des suivants :

chatCompletionRequestAssistantMessageContentPart

Ce composant peut être l’un des suivants :

chatCompletionRequestToolMessageContentPart

Ce composant peut être l’un des suivants :

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartImage

Propriétés pour image_url

url

detail

chatCompletionRequestMessageContentPartRefusal

configuration de l'extension de chat Azure

Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.

azureChatExtensionType

Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.

Description : Représentation des données de configuration pour une seule extension de chat OpenAI Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.

Type : chaîne

Valeur par défaut :

Enum Name : AzureChatExtensionType

Valeurs d’énumération :

Configuration d'extension de chat Azure Search

Une représentation spécifique des options configurables pour Azure Search lorsqu’on l’utilise comme extension de chat OpenAI d’Azure.

azureSearchChatExtensionParameters

Paramètres pour Azure Search lorsqu’ils sont utilisés comme extension de chat OpenAI Azure.

Options de mappage de champs de l'index de recherche Azure

Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Azure Search configurée.

azureSearchQueryType

Le type de requête de recherche Azure qui doit être exécutée lorsqu’on l’utilise comme extension de chat OpenAI Azure.

Description : Le type de requête de recherche Azure à effectuer lorsqu’il est utilisé comme extension de chat OpenAI Azure.

Type : chaîne

Valeur par défaut :

Enum Name : AzureSearchQueryType

Valeurs d’énumération :

azureCosmosDBChatExtensionConfiguration

Une représentation spécifique des options configurables pour Azure Cosmos DB lorsqu’il est utilisé comme extension de chat Azure OpenAI.

azureCosmosDBChatExtensionParameters

Paramètres à utiliser lors de la configuration des extensions de chat Azure OpenAI On Your Data lors de l’utilisation d’Azure Cosmos DB pour MongoDB vCore.

azureCosmosDBFieldMappingOptions

Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Azure Cosmos DB configurée.

surVosOptionsD'AuthentificationDesDonnées

Les options d’authentification pour Azure OpenAI sur vos données.

onYourDataAuthenticationType

Les types d’authentification pris en charge par Azure OpenAI On Your Data.

Description : Les types d’authentification pris en charge par Azure OpenAI On Your Data.

Type : chaîne

Valeur par défaut :

Nom d’enum : OnYourDataAuthenticationType

Valeurs d’énumération :

onYourDataApiKeyAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une clé API.

onYourDataConnectionStringAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une chaîne de connexion.

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une identité managée attribuée au système.

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une identité managée attribuée par l’utilisateur.

onYourDataVectorizationSource

Une représentation abstraite d’une source de vectorisation pour Azure OpenAI On Your Data avec recherche vectorielle.

onYourDataVectorizationSourceType

Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.

Description : Représente les sources disponibles Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec
recherche vectorielle.

Type : chaîne

Valeur par défaut :

Nom d’enum : OnYourDataVectorizationSourceType

Valeurs d’énumération :

onYourDataDeploymentNameVectorizationSource

Les détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, basée sur un nom de déploiement interne de modèle d’embeddings dans la même ressource Azure OpenAI.

onYourDataEndpointVectorizationSource

Les détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, basée sur un appel public d’intégration Azure OpenAI.

azureChatExtensionsMessageContext

Une représentation des informations contextuelles supplémentaires disponibles lorsque des extensions de chat OpenAI d’Azure sont impliquées dans la génération d’une réponse de complétion de chat correspondante. Ces informations contextuelles ne sont remplies que lorsqu’on utilise une requête OpenAI Azure configurée pour utiliser une extension correspondante.

citation

Informations de citation pour un message de réponse à la fin d’un chat.

chatCompletionMessageToolCall

Propriétés de la fonction

name

Arguments

toolCallType

Le type d’appel de l’outil, dans ce cas function.

Description : Le type d’appel à l’outil, dans ce cas function.

Type : chaîne

Valeur par défaut :

Nom d’enum : ToolCallType

Valeurs d’énumération :

chatCompletionRequestMessageTool

chatCompletionRequestMessageFunction

createChatCompletionResponse

Représente une réponse de fin de discussion retournée par le modèle, basée sur l’entrée fournie.

createChatCompletionStreamResponse

Représente un segment diffusé d’une réponse de fin de chat retournée par le modèle, basé sur l’entrée fournie.

chatCompletionStreamResponseDelta

Un delta de complétion du chat généré par les réponses du modèle en streaming.

Propriétés pour function_call

Arguments

name

chatCompletionMessageToolCallChunk

Propriétés de la fonction

name

Arguments

chatCompletionStreamOptions

Options pour la réponse en streaming. Ne réglez cela que lorsque vous activez stream: true.

chatCompletionChoiceLogProbs

Enregistrez les informations de probabilité pour le choix.

chatCompletionTokenLogprob

Message de réponse de complétion de chat

Un message de complétion de chat généré par le modèle.

chatCompletionResponseMessageRole

Le rôle de l’auteur du message de réponse.

Description : Le rôle de l’auteur du message de réponse.

Type : chaîne

Valeur par défaut :

Valeurs d’énumération :

• assistant

chatCompletionToolChoiceOption

Contrôle quel outil (le cas échéant) est appelé par le modèle. none cela signifie que le modèle n’appellera aucun outil et générera un message à la place. auto signifie que le modèle peut choisir entre générer un message ou appeler un ou plusieurs outils. required signifie que le modèle doit appeler un ou plusieurs outils. Spécifier un outil particulier force {"type": "function", "function": {"name": "my_function"}} le modèle à appeler cet outil. none est la norme par défaut lorsqu’aucun outil n’est présent. auto est la norme par défaut si des outils sont présents.

Ce composant peut être l’un des suivants :

chatCompletionNamedToolChoice

Spécifie un outil que le modèle doit utiliser. À utiliser pour forcer le modèle à appeler une fonction spécifique.

Propriétés de la fonction

name

ParallelToolCalls

S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.

Aucune propriété définie pour ce composant.

chatCompletionMessageToolCalls

Les appels d’outils générés par le modèle, tels que les appels de fonction.

Aucune propriété définie pour ce composant.

chatCompletionFunctionCall

Déprécié et remplacé par tool_calls. Le nom et les arguments d’une fonction à appeler, tels que générés par le modèle.

completionUsage

Statistiques d’utilisation pour la demande de complétion.

Propriétés pour completion_tokens_details

jetons_de_raisonnement

chatCompletionTool

FunctionParameters

Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, ainsi que la référence du schéma JSON pour la documentation sur le format.

Omettre parameters définit une fonction avec une liste de paramètres vide.

Aucune propriété définie pour ce composant.

FunctionObject

ResponseFormatText

ResponseFormatJsonObject

ResponseFormatJsonSchemaSchema

Le schéma pour le format de réponse est décrit comme un objet de schéma JSON.

Aucune propriété définie pour ce composant.

ResponseFormatJsonSchema

Propriétés pour json_schema

description

name

schema

strict

chatCompletionChoiceCommon

créerDemandeDeTraduction

Demande de traduction.

réponse audio

Réponse à la traduction ou à la transcription lorsque response_format était json

audioVerboseResponse

Réponse à la traduction ou à la transcription lorsque response_format était verbose_json

audioResponseFormat

Définit le format de la sortie.

Description : Définit le format de la sortie.

Type : chaîne

Valeur par défaut :

Valeurs d’énumération :

• Json
• texte
• SRT
• verbose_json
• vtt

créerDemandeDeTranscription

Demande de transcription.

audioSegment

Segment de transcription ou de traduction.

imageQuality

La qualité de l’image qui sera générée.

Description : La qualité de l’image qui sera générée.

Type : chaîne

Valeur par défaut : standard

Nom Enum : Qualité

Valeurs d’énumération :

imagesResponseFormat

Le format dans lequel les images générées sont renvoyées.

Description : Le format dans lequel les images générées sont renvoyées.

Type : chaîne

Valeur par défaut : URL

Nom d’enum : ImagesResponseFormat

Valeurs d’énumération :

taille de l’image

La taille des images générées.

Description : La taille des images générées.

Type : chaîne

Valeur par défaut : 1024x1024

Nom Enum : Taille

Valeurs d’énumération :

imageStyle

Le style des images générées.

Description : Le style des images générées.

Type : chaîne

Valeur par défaut : vif

Nom Enum : Style

Valeurs d’énumération :

demandeDeGénérationD'Images

generateImagesResponse

résultat d'image

L’URL de l’image ou l’image encodée si elle réussit, et une erreur sinon.

Extensions de saisie semi-automatique

Les extensions de complétion ne font pas partie de la dernière version GA de la spécification d'inférence du plan de données OpenAI d'Azure.

Chatmessage

L'objet message Chat ne fait pas partie de la dernière version GA de la spécification d'inférence du plan de données OpenAI d'Azure.

Synthèse vocale (Aperçu)

Ne fait actuellement pas partie de la dernière version Azure OpenAI GA de la spécification d’inférence du plan de données OpenAI Azure. Consultez la dernière version aperçu pour cette fonctionnalité.

Étapes suivantes

Apprenez-en plus sur les modèles et l’ajustement fin avec l’API REST. En savoir plus sur les modèles sous-jacents qui alimentent Azure OpenAI.