Delen via

Naslaginformatie over azure OpenAI Service REST API Preview

  • Artikel

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:

  • Besturingsvlak
  • 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.

API Nieuwste preview-versie Nieuwste GA-release Specificaties Beschrijving
Besturingsvlak 2024-06-01-preview 2024-10-01 Specificatiebestanden Azure OpenAI deelt een gemeenschappelijk besturingsvlak met alle andere Azure AI Services. De besturingsvlak-API wordt gebruikt voor zaken als het maken van Azure OpenAI-resources, modelimplementatie en andere resourcebeheertaken op een hoger niveau. Het besturingsvlak bepaalt ook wat er mogelijk is met mogelijkheden zoals Azure Resource Manager, Bicep, Terraform en Azure CLI.
Gegevensvlak - ontwerpen 2024-10-01-preview 2024-10-21 Specificatiebestanden De api voor het ontwerpen van gegevensvlakken bepaalt het afstemmen, uploaden van bestanden, opnametaken, batch- en bepaalde query's op modelniveau
Gegevensvlak - deductie 2024-10-01-preview 2024-10-21 Specificatiebestanden De gegevensvlakdeductie-API biedt de deductiemogelijkheden/eindpunten voor functies zoals voltooiingen, chatvoltooiingen, insluitingen, spraak/fluisteren, op uw gegevens, Dall-e, assistenten, enzovoort.

Verificatie

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 preview-versie van de deductiespecificatie van het Azure OpenAI-gegevensvlak. 2024-10-01-preview Dit artikel bevat documentatie voor de nieuwste preview-mogelijkheden, zoals assistenten, threads en vectorarchieven.

Als u op zoek bent naar documentatie over de nieuwste GA API-release, raadpleegt u de nieuwste GA-gegevensvlakdeductie-API

Voltooiingen - Maken

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

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

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
implementatie-id path Ja tekenreeks Implementatie-id van het model dat is geïmplementeerd.
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
vraag tekenreeks of matrix De prompt(s) voor het genereren van voltooiingen voor, gecodeerd als een tekenreeks, matrix van tekenreeksen, matrix van tokens of matrix van tokenmatrices.

<|endoftext|> is het documentscheidingsteken dat het model tijdens de training ziet, dus als er geen prompt is opgegeven, wordt het model gegenereerd alsof het vanaf het begin van een nieuw document wordt gegenereerd.
 Ja
best_of geheel getal Genereert best_of voltooiingen aan de serverzijde en retourneert de 'beste' (de waarde met de hoogste logboekkans per token). Resultaten kunnen niet worden gestreamd.

Wanneer gebruikt met n, best_of bepaalt u het aantal voltooiingen van de kandidaat en n geeft u op hoeveel te retourneren â€" best_of groter moet zijn dan n.

Opmerking: Omdat deze parameter veel voltooiingen genereert, kan deze snel uw tokenquotum gebruiken. Gebruik zorgvuldig en zorg ervoor dat u redelijke instellingen max_tokens voor en stop.
 Nee 1
echo boolean Echo terug van de prompt naast de voltooiing
 Nee Onwaar
frequency_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van hun bestaande frequentie in de tekst, waardoor de kans dat het model dezelfde regelzin herhaalt, afneemt.
 Nee 0
logit_bias object Wijzig de kans dat opgegeven tokens worden weergegeven in de voltooiing.

Accepteert een JSON-object waarmee tokens (opgegeven door de token-id in de GPT-tokenizer) worden toegewezen aan een bijbehorende bias-waarde van -100 tot 100. Wiskundig wordt de vooroordelen toegevoegd aan de logboeken die door het model worden gegenereerd voordat ze worden genomen. Het exacte effect verschilt per model, maar waarden tussen -1 en 1 moeten de kans op selectie verkleinen of vergroten; waarden zoals -100 of 100 moeten resulteren in een verbod of exclusieve selectie van het relevante token.

U kunt bijvoorbeeld doorgeven {"50256": -100} om te voorkomen dat het <token |endoftext|> wordt gegenereerd.
 Nee Geen
logprobs geheel getal Neem de logboekkans op de logprobs meest waarschijnlijke uitvoertokens op, evenals de gekozen tokens. Als dit bijvoorbeeld logprobs 5 is, retourneert de API een lijst met de vijf meest waarschijnlijke tokens. De API retourneert altijd het logprob voorbeeldtoken, dus er kunnen maximaal logprobs+1 elementen in het antwoord zijn.

De maximumwaarde voor logprobs is 5.
 Nee Geen
max_tokens geheel getal Het maximum aantal tokens dat kan worden gegenereerd in de voltooiing.

Het tokenaantal van uw prompt plus max_tokens kan de contextlengte van het model niet overschrijden.
Nee 16
n geheel getal Hoeveel voltooiingen moeten worden gegenereerd voor elke prompt.

Opmerking: Omdat deze parameter veel voltooiingen genereert, kan deze snel uw tokenquotum gebruiken. Gebruik zorgvuldig en zorg ervoor dat u redelijke instellingen max_tokens voor en stop.
 Nee 1
presence_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van of ze tot nu toe worden weergegeven in de tekst, waardoor de kans op het model groter wordt om over nieuwe onderwerpen te praten.
 Nee 0
seed geheel getal Indien opgegeven, zal ons systeem een best inspanning leveren om de steekproef deterministisch uit te voeren, zodat herhaalde aanvragen met hetzelfde seed en parameters hetzelfde resultaat moeten retourneren.

Determinisme is niet gegarandeerd en u moet verwijzen naar de system_fingerprint antwoordparameter om wijzigingen in de back-end te controleren.
 Nee
stoppen tekenreeks of matrix Maximaal vier reeksen waarin de API stopt met het genereren van verdere tokens. De geretourneerde tekst bevat de stopvolgorde niet.
 Nee
stroom boolean Of gedeeltelijke voortgang moet worden gestreamd. Als deze optie is ingesteld, worden tokens verzonden als gebeurtenissen die alleen door de server worden verzonden zodra ze beschikbaar komen, waarbij de stream wordt beëindigd door een data: [DONE] bericht.
 Nee Onwaar
achtervoegsel tekenreeks Het achtervoegsel dat na een voltooiing van ingevoegde tekst komt.

Deze parameter wordt alleen ondersteund voor gpt-3.5-turbo-instruct.
 Nee Geen
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.

Over het algemeen raden we u aan dit of top_p niet beide te wijzigen.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan dit of temperature niet beide te wijzigen.
 Nee 1
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json createCompletionResponse Vertegenwoordigt een voltooiingsantwoord van de API. Opmerking: zowel de gestreamde als niet-gestreamde antwoordobjecten delen dezelfde vorm (in tegenstelling tot het chateindpunt).

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Content-Type Type Beschrijving
application/json errorResponse

Voorbeelden

Opmerking

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-01-preview

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

Insluitingen - Maken

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

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

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
implementatie-id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
input tekenreeks of matrix Invoertekst voor insluiten, gecodeerd als een tekenreeks of matrix met tokens. Als u meerdere invoer in één aanvraag wilt insluiten, geeft u een matrix van tekenreeksen of matrix met tokenmatrices door. De invoer mag niet groter zijn dan de maximuminvoertokens voor het model (8.192 tokens voor text-embedding-ada-002), mag geen lege tekenreeks zijn en een matrix moet 2048 dimensies of minder zijn. Ja
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik. Nee
input_type tekenreeks invoertype van zoekactie voor insluiten om te gebruiken Nee
encoding_format tekenreeks De indeling waarin de insluitingen moeten worden geretourneerd. Kan een van float beide zijn of base64. Standaard ingesteld op float. Nee
dimensions geheel getal Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Alleen ondersteund in text-embedding-3 en latere modellen. Nee

Antwoorden

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
model tekenreeks Ja
gegevens matrix Ja
gebruikt object Ja

Eigenschappen voor gebruik

prompt_tokens

Name Type Description Standaard
prompt_tokens geheel getal

total_tokens

Name Type Description Standaard
total_tokens geheel getal

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json object

Voorbeelden

Opmerking

Retourneer de insluitingen voor een bepaalde prompt.

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

{
 "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,
          0.0032178196
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Chatvoltooiingen - Maken

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

Hiermee maakt u een voltooiing voor het chatbericht

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
implementatie-id path Ja tekenreeks Implementatie-id van het model dat is geïmplementeerd.
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.

Over het algemeen raden we u aan dit of top_p niet beide te wijzigen.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan dit of temperature niet beide te wijzigen.
 Nee 1
stroom boolean Als dit is ingesteld, worden gedeeltelijke berichtdelta's verzonden, zoals in ChatGPT. Tokens worden verzonden als door de server verzonden gegevens wanneer ze beschikbaar zijn, waarbij de stream wordt beëindigd door een data: [DONE] bericht.
 Nee Onwaar
stoppen tekenreeks of matrix Maximaal vier reeksen waarin de API stopt met het genereren van verdere tokens.
 Nee
max_tokens geheel getal Het maximum aantal tokens dat kan worden gegenereerd in de voltooiing van de chat.

De totale lengte van invoertokens en gegenereerde tokens wordt beperkt door de contextlengte van het model.
Nee
max_completion_tokens geheel getal Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een voltooiing, inclusief zichtbare uitvoertokens en redeneringstokens. Dit wordt alleen ondersteund in o1-seriemodellen. Breidt de ondersteuning uit naar andere modellen in toekomstige API-release. Nee
presence_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van of ze tot nu toe worden weergegeven in de tekst, waardoor de kans op het model groter wordt om over nieuwe onderwerpen te praten.
 Nee 0
frequency_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van hun bestaande frequentie in de tekst, waardoor de kans dat het model dezelfde regelzin herhaalt, afneemt.
 Nee 0
logit_bias object Wijzig de kans dat opgegeven tokens worden weergegeven in de voltooiing.

Accepteert een JSON-object waarmee tokens (opgegeven door de token-id in de tokenizer) worden toegewezen aan een gekoppelde bias-waarde van -100 tot 100. Wiskundig wordt de vooroordelen toegevoegd aan de logboeken die door het model worden gegenereerd voordat ze worden genomen. Het exacte effect verschilt per model, maar waarden tussen -1 en 1 moeten de kans op selectie verkleinen of vergroten; waarden zoals -100 of 100 moeten resulteren in een verbod of exclusieve selectie van het relevante token.
 Nee Geen
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik.
 Nee
messages matrix Een lijst met berichten die tot nu toe bestaan uit het gesprek. Ja
data_sources matrix De configuratievermeldingen voor Azure OpenAI-chatextensies die deze gebruiken.
Deze aanvullende specificatie is alleen compatibel met Azure OpenAI.		 Nee
logprobs boolean Of u nu logboekkansen van de uitvoertokens wilt retourneren of niet. Indien waar, retourneert u de logboekkans van elk uitvoertoken dat wordt geretourneerd in de van content message. Nee Onwaar
top_logprobs geheel getal Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans. logprobs moet worden ingesteld op true of deze parameter wordt gebruikt. Nee
n geheel getal Hoeveel opties voor het voltooien van chats voor elk invoerbericht moeten worden gegenereerd. Houd er rekening mee dat er kosten in rekening worden gebracht op basis van het aantal gegenereerde tokens voor alle opties. 1 Houd n rekening met het minimaliseren van de kosten. Nee 1
parallel_tool_calls ParallelToolCalls Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma. Nee Waar
response_format ResponseFormatText of ResponseFormatJsonObject of ResponseFormatJsonSchema Een object dat de indeling aangeeft die het model moet uitvoeren. Compatibel met GPT-4o, GPT-4o mini, GPT-4 Turbo en alle GPT-3.5 Turbo modellen nieuwer dan gpt-3.5-turbo-1106.

Instelling voor { "type": "json_schema", "json_schema": {...} } het inschakelen van gestructureerde uitvoer die garandeert dat het model overeenkomt met het opgegeven JSON-schema.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee
seed geheel getal Deze functie bevindt zich in de bètaversie.
Indien opgegeven, zal ons systeem een best inspanning leveren om de steekproef deterministisch uit te voeren, zodat herhaalde aanvragen met hetzelfde seed en parameters hetzelfde resultaat moeten retourneren.
Determinisme is niet gegarandeerd en u moet verwijzen naar de system_fingerprint antwoordparameter om wijzigingen in de back-end te controleren.
 Nee
stream_options chatCompletionStreamOptions Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt stream: true.
 Nee Geen
tools matrix Een lijst met hulpprogramma's die het model kan aanroepen. Op dit moment worden alleen functies ondersteund als hulpprogramma. Gebruik dit om een lijst met functies op te geven waarvoor het model JSON-invoer kan genereren. Maximaal 128 functies worden ondersteund.
 Nee
tool_choice chatCompletionToolChoiceOption 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. Nee
function_call tekenreeks of chatCompletionFunctionCallOption Afgeschaft ten gunste van tool_choice.

Hiermee bepaalt u welke functie (indien aanwezig) wordt aangeroepen door het model.
none betekent dat het model geen functie 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 functie.
Als u een bepaalde functie opgeeft via dwingt {"name": "my_function"} u het model om die functie aan te roepen.

none is de standaardinstelling wanneer er geen functies aanwezig zijn. auto is de standaardinstelling als er functies aanwezig zijn.
 Nee
functions matrix Afgeschaft ten gunste van tools.

Een lijst met functies waarvoor het model JSON-invoer kan genereren.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json createChatCompletionResponse of createChatCompletionStreamResponse

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Content-Type Type Beschrijving
application/json errorResponse

Voorbeelden

Opmerking

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-01-preview

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

Opmerking

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-01-preview

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

Opmerking

Hiermee maakt u een voltooiing op basis van afbeeldingsvectorgegevens van Azure Search.

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

{
 "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}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Opmerking

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-01-preview

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

Opmerking

Hiermee maakt u een voltooiing voor de opgegeven Azure Cosmos DB.

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

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

Opmerking

Hiermee maakt u een voltooiing voor de opgegeven Mongo-database.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "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
    }
  }
}

Opmerking

Hiermee maakt u een voltooiing voor de opgegeven Elasticsearch.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

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

Opmerking

Hiermee maakt u een voltooiing voor de opgegeven Pinecone-resource.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

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-01-preview

Hiermee wordt audio getranscribeerd in de invoertaal.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
implementatie-id path Ja tekenreeks Implementatie-id van het fluistermodel.
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: multipart/form-data

Name Type Beschrijving Vereist Standaardinstelling
bestand tekenreeks Het audiobestandobject dat moet worden getranscribeerd. Ja
vraag tekenreeks Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet overeenkomen met de audiotaal. Nee
response_format audioResponseFormat Hiermee definieert u de indeling van de uitvoer. Nee
temperatuur Nummer De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt. Nee 0
taal tekenreeks De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1-indeling verbetert de nauwkeurigheid en latentie. Nee
timestamp_granularities[] matrix De tijdstempelgranulariteiten die moeten worden ingevuld voor deze transcriptie. response_format moet worden ingesteld verbose_json op het gebruik van tijdstempelgranulariteiten. Of beide van deze opties worden ondersteund: word, of segment. Opmerking: er is geen extra latentie voor segmenttijdstempels, maar het genereren van woordtijdstempels zorgt voor extra latentie. Nee ['segment']

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json audioResponse of audioVerboseResponse
text/plain tekenreeks Getranscribeerde tekst in de uitvoerindeling (toen response_format een tekst, vtt of srt was).

Voorbeelden

Opmerking

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-01-preview

Antwoorden: Statuscode: 200

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

Opmerking

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-01-preview

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

Hiermee wordt invoeraudio getranscribeerd en omgezet in Engelse tekst.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
implementatie-id path Ja tekenreeks Implementatie-id van het fluistermodel dat is geïmplementeerd.
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: multipart/form-data

Name Type Beschrijving Vereist Standaardinstelling
bestand tekenreeks Het audiobestand dat moet worden vertaald. Ja
vraag tekenreeks Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet in het Engels zijn. Nee
response_format audioResponseFormat Hiermee definieert u de indeling van de uitvoer. Nee
temperatuur Nummer De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt. Nee 0

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json audioResponse of audioVerboseResponse
text/plain tekenreeks Getranscribeerde tekst in de uitvoerindeling (toen response_format een tekst, vtt of srt was).

Voorbeelden

Opmerking

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-01-preview

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

Opmerking

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-01-preview

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

Spraak - Maken

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview

Hiermee wordt audio gegenereerd op basis van de invoertekst.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
implementatie-id path Ja tekenreeks Implementatie-id van het tts-model dat is geïmplementeerd.
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: multipart/form-data

Name Type Beschrijving Vereist Standaardinstelling
invoer tekenreeks De tekst waarvoor audio moet worden gesynthetiseert. De maximale lengte is 4096 tekens. Ja
voice enum De stem die moet worden gebruikt voor spraaksynthese.
Mogelijke waarden: legering, echo, fable, onyx, nova, shimmer		 Ja
response_format enum De indeling om de audio in te synthetiseren.
Mogelijke waarden: mp3, opus, aac, flac, wav, pcm		 Nee
snelheid Nummer De snelheid van de gesynthetiseerde audio. Selecteer een waarde van waaruit 0.25 u wilt 4.0. 1.0 is de standaardwaarde. Nee 1.0

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/octet-stream tekenreeks

Voorbeelden

Opmerking

Synthetiseert audio van de opgegeven tekst.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Antwoorden: Statuscode: 200

{
  "body": "101010101"
}

Afbeeldingsgeneraties - Maken

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

Hiermee wordt een batch afbeeldingen gegenereerd op basis van een tekstbijschrift in een bepaalde DALLE-modelimplementatie

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
implementatie-id path Ja tekenreeks Implementatie-id van het dalle-model dat is geïmplementeerd.
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
vraag tekenreeks Een tekstbeschrijving van de gewenste afbeelding(en). De maximale lengte is 4000 tekens. Ja
n geheel getal Het aantal afbeeldingen dat moet worden gegenereerd. Nee 1
size imageSize De grootte van de gegenereerde afbeeldingen. Nee 1024x1024
response_format imagesResponseFormat De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Nee URL
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik. Nee
kwaliteit imageQuality De kwaliteit van de afbeelding die wordt gegenereerd. Nee standard
stijl imageStyle De stijl van de gegenereerde afbeeldingen. Nee levendig

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json generateImagesResponse

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Content-Type Type Beschrijving
application/json dalleErrorResponse

Voorbeelden

Opmerking

Hiermee maakt u installatiekopieën op basis van een prompt.

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

{
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Lijst - Assistenten

GET https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

Retourneert een lijst met assistenten.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
limiet query Nee geheel getal
order query Nee tekenreeks
na query Nee tekenreeks
voor query Nee tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json listAssistantsResponse

Voorbeelden

Opmerking

Retourneert een lijst met assistenten.

GET https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Maken - Assistent

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

Maak een assistent met een model en instructies.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
model Ja
naam tekenreeks De naam van de assistent. De maximale lengte is 256 tekens.
 Nee
beschrijving tekenreeks De beschrijving van de assistent. De maximale lengte is 512 tekens.
 Nee
Instructies tekenreeks De systeeminstructies die de assistent gebruikt. De maximale lengte is 256.000 tekens.
 Nee
tools matrix Een lijst met hulpprogramma's die is ingeschakeld voor de assistent. Er kunnen maximaal 128 hulpprogramma's per assistent zijn. Hulpprogramma's kunnen van het type code_interpreterzijn, retrievalof function.
 Nee []
tool_resources object Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []
Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze assistent is gekoppeld. Er kan maximaal één vectorarchief aan de assistent zijn gekoppeld.
vector_stores matrix Een helper voor het maken van een vectorarchief met file_ids en deze koppelen aan deze assistent. Er kan maximaal één vectorarchief aan de assistent zijn gekoppeld.

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json assistantObject Vertegenwoordigt een assistant die het model kan aanroepen en hulpprogramma's kan gebruiken.

Voorbeelden

Opmerking

Maak een assistent met een model en instructies.

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Get - Assistent

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Hiermee haalt u een assistent op.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
assistant_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json assistantObject Vertegenwoordigt een assistant die het model kan aanroepen en hulpprogramma's kan gebruiken.

Voorbeelden

Opmerking

Hiermee haalt u een assistent op.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Wijzigen - Assistent

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Hiermee wijzigt u een assistent.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
assistant_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
model Nee
naam tekenreeks De naam van de assistent. De maximale lengte is 256 tekens.
 Nee
beschrijving tekenreeks De beschrijving van de assistent. De maximale lengte is 512 tekens.
 Nee
Instructies tekenreeks De systeeminstructies die de assistent gebruikt. De maximale lengte is 32.768 tekens.
 Nee
tools matrix Een lijst met hulpprogramma's die is ingeschakeld voor de assistent. Er kunnen maximaal 128 hulpprogramma's per assistent zijn. Hulpprogramma's kunnen van het type code_interpreterzijn, retrievalof function.
 Nee []
tool_resources object Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Hiermee overschrijft u de lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Overschrijft het vectorarchief dat aan deze assistent is gekoppeld. Er kan maximaal één vectorarchief aan de assistent zijn gekoppeld.

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json assistantObject Vertegenwoordigt een assistant die het model kan aanroepen en hulpprogramma's kan gebruiken.

Voorbeelden

Opmerking

Hiermee wijzigt u een assistent.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Verwijderen - Assistent

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Een assistent verwijderen.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
assistant_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json deleteAssistantResponse

Voorbeelden

Opmerking

Hiermee verwijdert u een assistent.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Maken - Thread

POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview

Een thread maken.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
messages matrix Een lijst met berichten waarmee de thread moet worden gestart. Nee
tool_resources object Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze thread is gekoppeld. Er kan maximaal 1 vectoropslag aan de thread zijn gekoppeld.
vector_stores matrix Een helper voor het maken van een vectorarchief met file_ids en deze aan deze thread koppelen. Er kan maximaal één vectorarchief aan de thread zijn gekoppeld.

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json threadObject Vertegenwoordigt een thread die berichten bevat.

Voorbeelden

Opmerking

Hiermee maakt u een thread.

POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Ophalen - Thread

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Hiermee wordt een thread opgehaald.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json threadObject Vertegenwoordigt een thread die berichten bevat.

Voorbeelden

Opmerking

Hiermee wordt een thread opgehaald.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Wijzigen - Thread

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Hiermee wijzigt u een thread.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
tool_resources object Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze thread is gekoppeld. Er kan maximaal één vectorarchief aan de thread zijn gekoppeld.

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json threadObject Vertegenwoordigt een thread die berichten bevat.

Voorbeelden

Opmerking

Hiermee wijzigt u een thread.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Verwijderen - Thread

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Een thread verwijderen.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json deleteThreadResponse

Voorbeelden

Opmerking

Hiermee wordt een thread verwijderd.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Lijst - Berichten

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

Retourneert een lijst met berichten voor een bepaalde thread.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
limiet query Nee geheel getal
order query Nee tekenreeks
na query Nee tekenreeks
voor query Nee tekenreeks
run_id query Nee tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json listMessagesResponse

Voorbeelden

Opmerking

Berichten weergeven

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Maken - Bericht

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

Maak een bericht.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
role tekenreeks De rol van de entiteit die het bericht maakt. Toegestane waarden zijn:
- user: Geeft aan dat het bericht wordt verzonden door een werkelijke gebruiker en moet in de meeste gevallen worden gebruikt om door de gebruiker gegenereerde berichten weer te geven.
- assistant: Geeft aan dat het bericht wordt gegenereerd door de assistent. Gebruik deze waarde om berichten van de assistent in te voegen in het gesprek.
 Ja
content tekenreeks De inhoud van het bericht. Ja
Bijlagen matrix Een lijst met bestanden die zijn toegevoegd aan het bericht en de hulpmiddelen waaraan ze moeten worden toegevoegd. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json messageObject Vertegenwoordigt een bericht in een thread.

Voorbeelden

Opmerking

Maak een bericht.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Ophalen - Bericht

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

Een bericht ophalen.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
message_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json messageObject Vertegenwoordigt een bericht in een thread.

Voorbeelden

Opmerking

Een bericht ophalen.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Wijzigen - Bericht

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

Hiermee wijzigt u een bericht.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
message_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json messageObject Vertegenwoordigt een bericht in een thread.

Voorbeelden

Opmerking

Een bericht wijzigen.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Maken - thread en uitvoeren

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview

Maak een thread en voer deze in één aanvraag uit.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
assistant_id tekenreeks De id van de assistent die moet worden gebruikt om deze uitvoering uit te voeren. Ja
thread createThreadRequest Nee
model tekenreeks De implementatienaam van het model dat moet worden gebruikt om deze uitvoering uit te voeren. Als hier een waarde wordt opgegeven, wordt het model dat aan de assistent is gekoppeld, overschreven. Zo niet, dan wordt het model gebruikt dat is gekoppeld aan de assistent. Nee
Instructies tekenreeks Overschrijf het standaardsysteembericht van de assistent. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
tools matrix Overschrijf de hulpprogramma's die de assistent voor deze uitvoering kan gebruiken. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
tool_resources object Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
stroom boolean Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.
 Nee
stream_options chatCompletionStreamOptions Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt stream: true.
 Nee Geen
max_prompt_tokens geheel getal Het maximum aantal prompttokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven prompttokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven prompttokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
max_completion_tokens geheel getal Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven voltooiingstokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven voltooiingstokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
truncation_strategy truncationObject Besturingselementen voor hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. Gebruik deze optie om het eerste contextvenster van de uitvoering te beheren. Nee
tool_choice assistantsApiToolChoiceOption Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model.
none betekent dat het model geen hulpprogramma's aanroept en in plaats daarvan een bericht genereert.
auto is de standaardwaarde en betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een hulpprogramma.
Het opgeven van een bepaald hulpprogramma zoals {"type": "file_search"} of {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpprogramma aan te roepen.
 Nee
parallel_tool_calls ParallelToolCalls Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma. Nee Waar
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix De id van het vectorarchief dat aan deze assistent is gekoppeld. Er kan maximaal één vectorarchief aan de assistent zijn gekoppeld.

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread.

Voorbeelden

Opmerking

Maak een thread en voer deze in één aanvraag uit.

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Lijst - Uitvoeringen

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

Retourneert een lijst met uitvoeringen die behoren tot een thread.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
limiet query Nee geheel getal
order query Nee tekenreeks
na query Nee tekenreeks
voor query Nee tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json listRunsResponse

Voorbeelden

Opmerking

Retourneert een lijst met uitvoeringen die behoren tot een thread.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Maken - Uitvoeren

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

Maak een uitvoering.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
assistant_id tekenreeks De id van de assistent die moet worden gebruikt om deze uitvoering uit te voeren. Ja
model tekenreeks De id van het model dat moet worden gebruikt om deze uitvoering uit te voeren. Als hier een waarde wordt opgegeven, wordt het model dat aan de assistent is gekoppeld, overschreven. Zo niet, dan wordt het model gebruikt dat is gekoppeld aan de assistent. Nee
Instructies tekenreeks Overschrijf het standaardsysteembericht van de assistent. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
additional_instructions tekenreeks Voegt aanvullende instructies toe aan het einde van de instructies voor de uitvoering. Dit is handig voor het wijzigen van het gedrag per uitvoering zonder andere instructies te overschrijven. Nee
additional_messages matrix Voegt extra berichten toe aan de thread voordat u de uitvoering maakt. Nee
tools matrix Overschrijf de hulpprogramma's die de assistent voor deze uitvoering kan gebruiken. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
stroom boolean Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.
 Nee
max_prompt_tokens geheel getal Het maximum aantal prompttokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven prompttokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven prompttokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
max_completion_tokens geheel getal Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven voltooiingstokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven voltooiingstokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
truncation_strategy truncationObject Besturingselementen voor hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. Gebruik deze optie om het eerste contextvenster van de uitvoering te beheren. Nee
tool_choice assistantsApiToolChoiceOption Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model.
none betekent dat het model geen hulpprogramma's aanroept en in plaats daarvan een bericht genereert.
auto is de standaardwaarde en betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een hulpprogramma.
Het opgeven van een bepaald hulpprogramma zoals {"type": "file_search"} of {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpprogramma aan te roepen.
 Nee
parallel_tool_calls ParallelToolCalls Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma. Nee Waar
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread.

Voorbeelden

Opmerking

Maak een uitvoering.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

{
 "assistant_id": "asst_abc123"
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Ophalen - Uitvoeren

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

Hiermee wordt een uitvoering opgehaald.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
run_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread.

Voorbeelden

Opmerking

Krijgt een vlucht.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Wijzigen - Uitvoeren

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

Hiermee wijzigt u een uitvoering.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
run_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread.

Voorbeelden

Opmerking

Hiermee wijzigt u een uitvoering.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Verzenden - Uitvoer van hulpprogramma's die moeten worden uitgevoerd

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

Wanneer een uitvoering de status: "requires_action" en required_action.type is submit_tool_outputs, kan dit eindpunt worden gebruikt om de uitvoer van de hulpprogramma-aanroepen te verzenden zodra ze allemaal zijn voltooid. Alle uitvoer moet in één aanvraag worden ingediend.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
run_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
tool_outputs matrix Een lijst met hulpprogramma's waarvoor de uitvoer wordt verzonden. Ja
stroom boolean Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread.

Voorbeelden

Opmerking

Wanneer een uitvoering de status: "requires_action" en required_action.type is submit_tool_outputs, kan dit eindpunt worden gebruikt om de uitvoer van de hulpprogramma-aanroepen te verzenden zodra ze allemaal zijn voltooid. Alle uitvoer moet in één aanvraag worden ingediend.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Annuleren - Uitvoeren

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

Annuleert een uitvoering die is in_progress.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
run_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread.

Voorbeelden

Opmerking

Annuleert een uitvoering die is in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Lijst - Stappen uitvoeren

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

Retourneert een lijst met uitvoeringsstappen die behoren tot een uitvoering.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
run_id path Ja tekenreeks
limiet query Nee geheel getal
order query Nee tekenreeks
na query Nee tekenreeks
voor query Nee tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json listRunStepsResponse

Voorbeelden

Opmerking

Retourneert een lijst met uitvoeringsstappen die behoren tot een uitvoering.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Ophalen - Stap uitvoeren

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

Haalt een uitvoeringsstap op.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
thread_id path Ja tekenreeks
run_id path Ja tekenreeks
step_id path Ja tekenreeks
api-versie query Ja tekenreeks API-versie

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json runStepObject Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.

Voorbeelden

Opmerking

Haalt een uitvoeringsstap op.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Lijst - Vector Stores

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Retourneert een lijst met vectorarchieven.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
limiet query Nee geheel getal
order query Nee tekenreeks
na query Nee tekenreeks
voor query Nee tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json listVectorStoresResponse

Voorbeelden

Opmerking

Retourneert een lijst met vectorarchieven.

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Maken - Vector Store

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Maak een vectorarchief.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
file_ids matrix Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals file_search die toegang hebben tot bestanden. Nee
naam tekenreeks De naam van het vectorarchief. Nee
expires_after vectorStoreExpirationAfter Het verloopbeleid voor een vectorarchief. Nee
chunking_strategy autoChunkingStrategyRequestParam of staticChunkingStrategyRequestParam De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt. Alleen van toepassing als file_ids dit niet nodig is. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreObject Een vectorarchief is een verzameling verwerkte bestanden die door het file_search hulpprogramma kunnen worden gebruikt.

Voorbeelden

Opmerking

Hiermee maakt u een vectorarchief.

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Ophalen - Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Hiermee haalt u een vectorarchief op.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreObject Een vectorarchief is een verzameling verwerkte bestanden die door het file_search hulpprogramma kunnen worden gebruikt.

Voorbeelden

Opmerking

Hiermee haalt u een vectorarchief op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Wijzigen - Vector Store

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Hiermee wijzigt u een vectorarchief.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
naam tekenreeks De naam van het vectorarchief. Nee
expires_after vectorStoreExpirationAfter Het verloopbeleid voor een vectorarchief. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreObject Een vectorarchief is een verzameling verwerkte bestanden die door het file_search hulpprogramma kunnen worden gebruikt.

Voorbeelden

Opmerking

Hiermee wijzigt u een vectorarchief.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

{
 "name": "Support FAQ"
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Verwijderen - Vector Store

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Een vectorarchief verwijderen.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json deleteVectorStoreResponse

Voorbeelden

Opmerking

Hiermee verwijdert u een vectorarchief.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Lijst - Vector Store-bestanden

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

Hiermee wordt een lijst met vectoropslagbestanden geretourneerd.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
limiet query Nee geheel getal
order query Nee tekenreeks
na query Nee tekenreeks
voor query Nee tekenreeks
filter query Nee tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json listVectorStoreFilesResponse

Voorbeelden

Opmerking

Hiermee wordt een lijst met vectoropslagbestanden geretourneerd.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Maken - Vector Store-bestand

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

Maak een vectorarchiefbestand door een bestand toe te voegen aan een vectorarchief.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
file_id tekenreeks Een bestands-id die door het vectorarchief moet worden gebruikt. Handig voor hulpprogramma's zoals file_search die toegang hebben tot bestanden. Ja
chunking_strategy chunkingStrategyRequestParam De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt. Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreFileObject Een lijst met bestanden die zijn gekoppeld aan een vectorarchief.

Voorbeelden

Opmerking

Maak een vectorarchiefbestand door een bestand toe te voegen aan een vectorarchief.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

{
 "file_id": "file-abc123"
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Ophalen - Vector Store-bestand

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Hiermee haalt u een vectorarchiefbestand op.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
file_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreFileObject Een lijst met bestanden die zijn gekoppeld aan een vectorarchief.

Voorbeelden

Opmerking

Hiermee haalt u een vectorarchiefbestand op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Verwijderen - Vector Store-bestand

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Een vectorarchiefbestand verwijderen. Hiermee wordt het bestand uit het vectorarchief verwijderd, maar het bestand zelf wordt niet verwijderd. Als u het bestand wilt verwijderen, gebruikt u het eindpunt van het bestand verwijderen.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
file_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json deleteVectorStoreFileResponse

Voorbeelden

Opmerking

Een vectorarchiefbestand verwijderen. Hiermee wordt het bestand uit het vectorarchief verwijderd, maar het bestand zelf wordt niet verwijderd. Als u het bestand wilt verwijderen, gebruikt u het eindpunt van het bestand verwijderen.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Maken - Vector Store File Batch

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview

Maak een bestandsbatch voor vectoropslag.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Aanvraagbody

Inhoudstype: toepassing/json

Name Type Beschrijving Vereist Standaardinstelling
file_ids matrix Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals file_search die toegang hebben tot bestanden. Ja
chunking_strategy chunkingStrategyRequestParam De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt. Nee

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreFileBatchObject Een batch bestanden die zijn gekoppeld aan een vectorarchief.

Voorbeelden

Opmerking

Maak een bestandsbatch voor vectoropslag.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Antwoorden: Statuscode: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Ophalen - Vector Store File Batch

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

Hiermee haalt u een bestandsbatch van het vectorarchief op.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
batch_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreFileBatchObject Een batch bestanden die zijn gekoppeld aan een vectorarchief.

Voorbeelden

Opmerking

Hiermee haalt u een bestandsbatch van het vectorarchief op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Annuleren - Vector Store File Batch

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

Annuleer een bestandsbatch voor het vectorarchief. Hiermee wordt geprobeerd de verwerking van bestanden in deze batch zo snel mogelijk te annuleren.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
batch_id path Ja tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json vectorStoreFileBatchObject Een batch bestanden die zijn gekoppeld aan een vectorarchief.

Voorbeelden

Opmerking

Annuleer een bestandsbatch voor het vectorarchief. Hiermee wordt geprobeerd de verwerking van bestanden in deze batch zo snel mogelijk te annuleren.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Lijst - Bestandsbatchbestanden van Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

Retourneert een lijst met vectoropslagbestanden in een batch.

URI-parameters

Naam In Vereist Type Description
endpoint path Ja tekenreeks
URL		 Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-resource). https://{uw-resourcenaam}.openai.azure.com
vector_store_id path Ja tekenreeks
batch_id path Ja tekenreeks
limiet query Nee geheel getal
order query Nee tekenreeks
na query Nee tekenreeks
voor query Nee tekenreeks
filter query Nee tekenreeks
api-versie query Ja tekenreeks

Aanvraagkoptekst

Naam Vereist Type Description
api-key Waar tekenreeks Geef hier de Azure OpenAI API-sleutel op

Antwoorden

Statuscode: 200

Beschrijving: OK

Content-Type Type Beschrijving
application/json listVectorStoreFilesResponse

Voorbeelden

Opmerking

Hiermee wordt een lijst met vectoropslagbestanden geretourneerd.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

Antwoorden: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Onderdelen

errorResponse

Name Type Beschrijving Vereist Standaardinstelling
error fout Nee

errorBase

Name Type Beschrijving Vereist Standaardinstelling
code string Nee
bericht tekenreeks Nee

error

Name Type Beschrijving Vereist Standaardinstelling
param tekenreeks Nee
type tekenreeks Nee
inner_error innerError Interne fout met aanvullende details. Nee

innerError

Interne fout met aanvullende details.

Name Type Beschrijving Vereist Standaardinstelling
code innerErrorCode Foutcodes voor het binnenste foutobject. Nee
content_filter_results contentFilterPromptResults 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. Nee

innerErrorCode

Foutcodes voor het binnenste foutobject.

Beschrijving: Foutcodes voor het binnenste foutobject.

Type: tekenreeks

Standaard:

Opsommingsnaam: InnerErrorCode

Enum-waarden:

Weergegeven als Beschrijving
ResponsibleAIPolicyViolation De prompt heeft een van meer regels voor inhoudsfilters geschonden.

dalleErrorResponse

Name Type Beschrijving Vereist Standaardinstelling
error dalleError Nee

dalleError

Name Type Beschrijving Vereist Standaardinstelling
param tekenreeks Nee
type tekenreeks Nee
inner_error dalleInnerError Interne fout met aanvullende details. Nee

dalleInnerError

Interne fout met aanvullende details.

Name Type Beschrijving Vereist Standaardinstelling
code innerErrorCode Foutcodes voor het binnenste foutobject. Nee
content_filter_results dalleFilterResults 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. Nee
revised_prompt tekenreeks De prompt die is gebruikt voor het genereren van de installatiekopieën, als er een revisie op de prompt is uitgevoerd. Nee

contentFilterCompletionTextSpan

Beschrijft een bereik binnen gegenereerde voltooiingstekst. Offset 0 is het eerste UTF32-codepunt van de voltooiingstekst.

Name Type Beschrijving Vereist Standaardinstelling
completion_start_offset geheel getal Verschuiving van het UTF32-codepunt dat begint met het bereik. Ja
completion_end_offset geheel getal Verschuiving van het eerste UTF32-codepunt dat wordt uitgesloten van het bereik. Dit veld is altijd gelijk aan completion_start_offset voor lege spanten. Dit veld is altijd groter dan completion_start_offset voor minder tijdspanne. Ja

contentFilterResultBase

Name Type Beschrijving Vereist Standaardinstelling
Gefilterde boolean Ja

contentFilterSeverityResult

Name Type Beschrijving Vereist Standaardinstelling
Gefilterde boolean Ja
ernst tekenreeks Nee

contentFilterDetectedResult

Name Type Beschrijving Vereist Standaardinstelling
Gefilterde boolean Ja
Gedetecteerd boolean Nee

contentFilterDetectedWithCitationResult

Name Type Beschrijving Vereist Standaardinstelling
citaat object Nee

Eigenschappen voor bronvermelding

URL

Name Type Description Standaard
URL tekenreeks

licentie

Name Type Description Standaard
licentie tekenreeks

contentFilterDetectedWithCompletionTextSpansResult

Name Type Beschrijving Vereist Standaardinstelling
details matrix Nee

contentFilterIdResult

Name Type Beschrijving Vereist Standaardinstelling
Gefilterde boolean Ja
id tekenreeks Nee

contentFilterResultsBase

Informatie over de resultaten van het filteren van inhoud.

Name Type Beschrijving Vereist Standaardinstelling
seksueel contentFilterSeverityResult Nee
geweld contentFilterSeverityResult Nee
haten contentFilterSeverityResult Nee
self_harm contentFilterSeverityResult Nee
Godslastering contentFilterDetectedResult Nee
custom_blocklists contentFilterDetailedResults Resultaten van inhoudsfilters met een detail van inhoudsfilter-id's voor de gefilterde segmenten. Nee
error errorBase Nee

contentFilterPromptResults

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.

Name Type Beschrijving Vereist Standaardinstelling
seksueel contentFilterSeverityResult Nee
geweld contentFilterSeverityResult Nee
haten contentFilterSeverityResult Nee
self_harm contentFilterSeverityResult Nee
Godslastering contentFilterDetectedResult Nee
custom_blocklists contentFilterDetailedResults Resultaten van inhoudsfilters met een detail van inhoudsfilter-id's voor de gefilterde segmenten. Nee
error errorBase Nee
Jailbreak contentFilterDetectedResult Nee
indirect_attack contentFilterDetectedResult Nee

contentFilterChoiceResults

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.

Name Type Beschrijving Vereist Standaardinstelling
seksueel contentFilterSeverityResult Nee
geweld contentFilterSeverityResult Nee
haten contentFilterSeverityResult Nee
self_harm contentFilterSeverityResult Nee
Godslastering contentFilterDetectedResult Nee
custom_blocklists contentFilterDetailedResults Resultaten van inhoudsfilters met een detail van inhoudsfilter-id's voor de gefilterde segmenten. Nee
error errorBase Nee
protected_material_text contentFilterDetectedResult Nee
protected_material_code contentFilterDetectedWithCitationResult Nee
ungrounded_material contentFilterDetectedWithCompletionTextSpansResult Nee

contentFilterDetailedResults

Resultaten van inhoudsfilters met een detail van inhoudsfilter-id's voor de gefilterde segmenten.

Name Type Beschrijving Vereist Standaardinstelling
Gefilterde boolean Ja
details matrix Nee

promptFilterResult

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

Name Type Beschrijving Vereist Standaardinstelling
prompt_index geheel getal Nee
content_filter_results contentFilterPromptResults 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. Nee

promptFilterResults

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.

dalleContentFilterResults

Informatie over de resultaten van het filteren van inhoud.

Name Type Beschrijving Vereist Standaardinstelling
seksueel contentFilterSeverityResult Nee
geweld contentFilterSeverityResult Nee
haten contentFilterSeverityResult Nee
self_harm contentFilterSeverityResult Nee

dalleFilterResults

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.

Name Type Beschrijving Vereist Standaardinstelling
seksueel contentFilterSeverityResult Nee
geweld contentFilterSeverityResult Nee
haten contentFilterSeverityResult Nee
self_harm contentFilterSeverityResult Nee
Godslastering contentFilterDetectedResult Nee
Jailbreak contentFilterDetectedResult Nee
custom_blocklists contentFilterDetailedResults Resultaten van inhoudsfilters met een detail van inhoudsfilter-id's voor de gefilterde segmenten. Nee

chatCompletionsRequestCommon

Name Type Beschrijving Vereist Standaardinstelling
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
Over het algemeen raden we u aan dit of top_p niet beide te wijzigen.		 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.
Over het algemeen raden we u aan dit of temperature niet beide te wijzigen.		 Nee 1
stroom boolean Als dit is ingesteld, worden gedeeltelijke berichtdelta's verzonden, zoals in ChatGPT. Tokens worden verzonden als door de server verzonden gegevens wanneer ze beschikbaar zijn, waarbij de stream wordt beëindigd door een data: [DONE] bericht. Nee Onwaar
stoppen tekenreeks of matrix Maximaal vier reeksen waarbij de API stopt met het genereren van verdere tokens. Nee
max_tokens geheel getal Het maximum aantal tokens dat is toegestaan voor het gegenereerde antwoord. Standaard is het aantal tokens dat het model kan retourneren (4096 - prompttokens). Dit is niet compatibel met o1-seriemodellen. Nee 4096
max_completion_tokens geheel getal Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een voltooiing, inclusief zichtbare uitvoertokens en redeneringstokens. Dit wordt alleen ondersteund in o1-seriemodellen. Breidt de ondersteuning uit naar andere modellen in toekomstige API-release. Nee
presence_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van of ze tot nu toe worden weergegeven in de tekst, waardoor de kans op het model groter wordt om over nieuwe onderwerpen te praten. Nee 0
frequency_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van hun bestaande frequentie in de tekst, waardoor de kans dat het model dezelfde regelzin herhaalt, afneemt. Nee 0
logit_bias object Wijzig de kans dat opgegeven tokens worden weergegeven in de voltooiing. Accepteert een json-object waarmee tokens (opgegeven door de token-id in de tokenizer) worden toegewezen aan een gekoppelde bias-waarde van -100 tot 100. Wiskundig wordt de vooroordelen toegevoegd aan de logboeken die door het model worden gegenereerd voordat ze worden genomen. Het exacte effect verschilt per model, maar waarden tussen -1 en 1 moeten de kans op selectie verkleinen of vergroten; waarden zoals -100 of 100 moeten resulteren in een verbod of exclusieve selectie van het relevante token. Nee
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee Azure OpenAI misbruik kan bewaken en detecteren. Nee

createCompletionRequest

Name Type Beschrijving Vereist Standaardinstelling
vraag tekenreeks of matrix De prompt(s) voor het genereren van voltooiingen voor, gecodeerd als een tekenreeks, matrix van tekenreeksen, matrix van tokens of matrix van tokenmatrices.

<|endoftext|> is het documentscheidingsteken dat het model tijdens de training ziet, dus als er geen prompt is opgegeven, wordt het model gegenereerd alsof het vanaf het begin van een nieuw document wordt gegenereerd.
 Ja
best_of geheel getal Genereert best_of voltooiingen aan de serverzijde en retourneert de 'beste' (de waarde met de hoogste logboekkans per token). Resultaten kunnen niet worden gestreamd.

Wanneer gebruikt met n, best_of bepaalt u het aantal voltooiingen van de kandidaat en n geeft u op hoeveel te retourneren â€" best_of groter moet zijn dan n.

Opmerking: Omdat deze parameter veel voltooiingen genereert, kan deze snel uw tokenquotum gebruiken. Gebruik zorgvuldig en zorg ervoor dat u redelijke instellingen max_tokens voor en stop.
 Nee 1
echo boolean Echo terug van de prompt naast de voltooiing
 Nee Onwaar
frequency_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van hun bestaande frequentie in de tekst, waardoor de kans dat het model dezelfde regelzin herhaalt, afneemt.
 Nee 0
logit_bias object Wijzig de kans dat opgegeven tokens worden weergegeven in de voltooiing.

Accepteert een JSON-object waarmee tokens (opgegeven door de token-id in de GPT-tokenizer) worden toegewezen aan een bijbehorende bias-waarde van -100 tot 100. Wiskundig wordt de vooroordelen toegevoegd aan de logboeken die door het model worden gegenereerd voordat ze worden genomen. Het exacte effect verschilt per model, maar waarden tussen -1 en 1 moeten de kans op selectie verkleinen of vergroten; waarden zoals -100 of 100 moeten resulteren in een verbod of exclusieve selectie van het relevante token.

U kunt bijvoorbeeld doorgeven {"50256": -100} om te voorkomen dat het <token |endoftext|> wordt gegenereerd.
 Nee Geen
logprobs geheel getal Neem de logboekkans op de logprobs meest waarschijnlijke uitvoertokens op, evenals de gekozen tokens. Als dit bijvoorbeeld logprobs 5 is, retourneert de API een lijst met de 5 meest waarschijnlijke tokens. De API retourneert altijd het logprob voorbeeldtoken, dus er kunnen maximaal logprobs+1 elementen in het antwoord zijn.

De maximumwaarde voor logprobs is 5.
 Nee Geen
max_tokens geheel getal Het maximum aantal tokens dat kan worden gegenereerd in de voltooiing.

Het tokenaantal van uw prompt plus max_tokens kan de contextlengte van het model niet overschrijden.
Nee 16
n geheel getal Hoeveel voltooiingen moeten worden gegenereerd voor elke prompt.

Opmerking: Omdat deze parameter veel voltooiingen genereert, kan deze snel uw tokenquotum gebruiken. Gebruik zorgvuldig en zorg ervoor dat u redelijke instellingen max_tokens voor en stop.
 Nee 1
presence_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van of ze tot nu toe worden weergegeven in de tekst, waardoor de kans op het model groter wordt om over nieuwe onderwerpen te praten.
 Nee 0
seed geheel getal Indien opgegeven, zal ons systeem een best inspanning leveren om de steekproef deterministisch uit te voeren, zodat herhaalde aanvragen met hetzelfde seed en parameters hetzelfde resultaat moeten retourneren.

Determinisme is niet gegarandeerd en u moet verwijzen naar de system_fingerprint antwoordparameter om wijzigingen in de back-end te controleren.
 Nee
stoppen tekenreeks of matrix Maximaal vier reeksen waarbij de API stopt met het genereren van verdere tokens. De geretourneerde tekst bevat de stopvolgorde niet.
 Nee
stroom boolean Of gedeeltelijke voortgang moet worden gestreamd. Als deze optie is ingesteld, worden tokens verzonden als gebeurtenissen die alleen door de server worden verzonden zodra ze beschikbaar komen, waarbij de stream wordt beëindigd door een data: [DONE] bericht.
Nee Onwaar
achtervoegsel tekenreeks Het achtervoegsel dat na een voltooiing van ingevoegde tekst komt.

Deze parameter wordt alleen ondersteund voor gpt-3.5-turbo-instruct.
 Nee Geen
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.

Over het algemeen raden we u aan dit of top_p niet beide te wijzigen.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan dit of temperature niet beide te wijzigen.
 Nee 1
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik.
 Nee

createCompletionResponse

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

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks Een unieke id voor de voltooiing. Ja
Keuzes matrix De lijst met voltooiingskeuzen die het model heeft gegenereerd voor de invoerprompt. Ja
aangemaakt geheel getal De Unix-tijdstempel (in seconden) van het moment waarop de voltooiing is gemaakt. Ja
model tekenreeks Het model dat wordt gebruikt voor voltooiing. Ja
prompt_filter_results promptFilterResults 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. Nee
system_fingerprint tekenreeks Deze vingerafdruk vertegenwoordigt de back-endconfiguratie waarmee het model wordt uitgevoerd.

Kan worden gebruikt in combinatie met de seed aanvraagparameter om te begrijpen wanneer er back-endwijzigingen zijn aangebracht die van invloed kunnen zijn op determinisme.
 Nee
object enum Het objecttype, dat altijd 'text_completion' is
Mogelijke waarden: text_completion		 Ja
gebruikt completionUsage Gebruiksstatistieken voor de voltooiingsaanvraag. Nee

createChatCompletionRequest

Name Type Beschrijving Vereist Standaardinstelling
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.

Over het algemeen raden we u aan dit of top_p niet beide te wijzigen.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan dit of temperature niet beide te wijzigen.
 Nee 1
stroom boolean Als dit is ingesteld, worden gedeeltelijke berichtdelta's verzonden, zoals in ChatGPT. Tokens worden verzonden als door de server verzonden gegevens wanneer ze beschikbaar zijn, waarbij de stream wordt beëindigd door een data: [DONE] bericht.
 Nee Onwaar
stoppen tekenreeks of matrix Maximaal vier reeksen waarbij de API stopt met het genereren van verdere tokens.
 Nee
max_tokens geheel getal Het maximum aantal tokens dat kan worden gegenereerd in de voltooiing van de chat.

De totale lengte van invoertokens en gegenereerde tokens wordt beperkt door de contextlengte van het model.
Nee
max_completion_tokens geheel getal Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een voltooiing, inclusief zichtbare uitvoertokens en redeneringstokens. Dit wordt alleen ondersteund in o1-seriemodellen. Breidt de ondersteuning uit naar andere modellen in toekomstige API-release. Nee
presence_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van of ze tot nu toe worden weergegeven in de tekst, waardoor de kans op het model groter wordt om over nieuwe onderwerpen te praten.
 Nee 0
frequency_penalty Nummer Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van hun bestaande frequentie in de tekst, waardoor de kans dat het model dezelfde regelzin herhaalt, afneemt.
 Nee 0
logit_bias object Wijzig de kans dat opgegeven tokens worden weergegeven in de voltooiing.

Accepteert een JSON-object waarmee tokens (opgegeven door de token-id in de tokenizer) worden toegewezen aan een gekoppelde bias-waarde van -100 tot 100. Wiskundig wordt de vooroordelen toegevoegd aan de logboeken die door het model worden gegenereerd voordat ze worden genomen. Het exacte effect verschilt per model, maar waarden tussen -1 en 1 moeten de kans op selectie verkleinen of vergroten; waarden zoals -100 of 100 moeten resulteren in een verbod of exclusieve selectie van het relevante token.
 Nee Geen
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik.
 Nee
messages matrix Een lijst met berichten die tot nu toe bestaan uit het gesprek. Ja
data_sources matrix De configuratievermeldingen voor Azure OpenAI-chatextensies die deze gebruiken.
Deze aanvullende specificatie is alleen compatibel met Azure OpenAI.		 Nee
logprobs boolean Of u nu logboekkansen van de uitvoertokens wilt retourneren of niet. Indien waar, retourneert u de logboekkans van elk uitvoertoken dat wordt geretourneerd in de van content message. Nee Onwaar
top_logprobs geheel getal Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans. logprobs moet worden ingesteld op true of deze parameter wordt gebruikt. Nee
n geheel getal Hoeveel opties voor het voltooien van chats voor elk invoerbericht moeten worden gegenereerd. Houd er rekening mee dat er kosten in rekening worden gebracht op basis van het aantal gegenereerde tokens voor alle opties. 1 Houd n rekening met het minimaliseren van de kosten. Nee 1
parallel_tool_calls ParallelToolCalls Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma. Nee Waar
response_format ResponseFormatText of ResponseFormatJsonObject of ResponseFormatJsonSchema Een object dat de indeling aangeeft die het model moet uitvoeren. Compatibel met GPT-4o, GPT-4o mini, GPT-4 Turbo en alle GPT-3.5 Turbo modellen nieuwer dan gpt-3.5-turbo-1106.

Instelling voor { "type": "json_schema", "json_schema": {...} } het inschakelen van gestructureerde uitvoer die garandeert dat het model overeenkomt met het opgegeven JSON-schema.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee
seed geheel getal Deze functie bevindt zich in de bètaversie.
Indien opgegeven, zal ons systeem een best inspanning leveren om de steekproef deterministisch uit te voeren, zodat herhaalde aanvragen met hetzelfde seed en parameters hetzelfde resultaat moeten retourneren.
Determinisme is niet gegarandeerd en u moet verwijzen naar de system_fingerprint antwoordparameter om wijzigingen in de back-end te controleren.
 Nee
stream_options chatCompletionStreamOptions Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt stream: true.
 Nee Geen
tools matrix Een lijst met hulpprogramma's die het model kan aanroepen. Op dit moment worden alleen functies ondersteund als hulpprogramma. Gebruik dit om een lijst met functies op te geven waarvoor het model JSON-invoer kan genereren. Maximaal 128 functies worden ondersteund.
 Nee
tool_choice chatCompletionToolChoiceOption 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. Nee
function_call tekenreeks of chatCompletionFunctionCallOption Afgeschaft ten gunste van tool_choice.

Hiermee bepaalt u welke functie (indien aanwezig) wordt aangeroepen door het model.
none betekent dat het model geen functie 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 functie.
Als u een bepaalde functie opgeeft via dwingt {"name": "my_function"} u het model om die functie aan te roepen.

none is de standaardinstelling wanneer er geen functies aanwezig zijn. auto is de standaardinstelling als er functies aanwezig zijn.
 Nee
functions matrix Afgeschaft ten gunste van tools.

Een lijst met functies waarvoor het model JSON-invoer kan genereren.
 Nee

chatCompletionFunctions

Name Type Beschrijving Vereist Default
beschrijving tekenreeks Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen. Nee
naam tekenreeks De naam van de functie die moet worden aangeroepen. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64. Ja
parameters 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.		 Nee

chatCompletionFunctionCallOption

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

Name Type Beschrijving Vereist Standaardinstelling
naam tekenreeks De naam van de functie die moet worden aangeroepen. Ja

chatCompletionFunctionParameters

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.

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

chatCompletionRequestMessage

Dit onderdeel kan een van de volgende zijn:

chatCompletionRequestSystemMessage

Name Type Beschrijving Vereist Standaardinstelling
content tekenreeks of matrix De inhoud van het systeembericht. Ja
role enum De rol van de auteur van berichten, in dit geval system.
Mogelijke waarden: systeem		 Ja
naam tekenreeks Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol. Nee

chatCompletionRequestUserMessage

Name Type Beschrijving Vereist Standaardinstelling
content tekenreeks of matrix De inhoud van het gebruikersbericht.
 Ja
role enum De rol van de auteur van berichten, in dit geval user.
Mogelijke waarden: gebruiker		 Ja
naam tekenreeks Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol. Nee

chatCompletionRequestAssistantMessage

Name Type Beschrijving Vereist Standaardinstelling
content tekenreeks of matrix De inhoud van het assistentbericht. Vereist tenzij tool_calls of function_call is opgegeven.
 Nee
weigering tekenreeks Het weigeringsbericht van de assistent. Nee
role enum De rol van de auteur van berichten, in dit geval assistant.
Mogelijke waarden: assistent		 Ja
naam tekenreeks Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol. Nee
tool_calls chatCompletionMessageToolCalls De hulpprogramma-aanroepen die door het model worden gegenereerd, zoals functie-aanroepen. Nee
function_call object Afgeschaft en vervangen door tool_calls. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model. Nee

Eigenschappen voor function_call

Argumenten

Name Type Description Standaard
Argumenten tekenreeks De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en mogelijk parameters genereert die niet zijn gedefinieerd door uw functieschema. Valideer de argumenten in uw code voordat u de functie aanroept.

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie die moet worden aangeroepen.

chatCompletionRequestToolMessage

Name Type Beschrijving Vereist Standaardinstelling
role enum De rol van de auteur van berichten, in dit geval tool.
Mogelijke waarden: hulpprogramma		 Ja
content tekenreeks of matrix De inhoud van het hulpmiddelbericht. Ja
tool_call_id tekenreeks De aanroep van het hulpprogramma waarop dit bericht reageert. Ja

chatCompletionRequestFunctionMessage

Name Type Beschrijving Vereist Standaardinstelling
role enum De rol van de auteur van berichten, in dit geval function.
Mogelijke waarden: functie		 Ja
content tekenreeks De inhoud van het functiebericht. Ja
naam tekenreeks De naam van de functie die moet worden aangeroepen. Ja

chatCompletionRequestSystemMessageContentPart

Dit onderdeel kan een van de volgende zijn:

chatCompletionRequestUserMessageContentPart

Dit onderdeel kan een van de volgende zijn:

chatCompletionRequestAssistantMessageContentPart

Dit onderdeel kan een van de volgende zijn:

chatCompletionRequestToolMessageContentPart

Dit onderdeel kan een van de volgende zijn:

chatCompletionRequestMessageContentPartText

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type inhoudsonderdeel.
Mogelijke waarden: tekst		 Ja
sms verzenden tekenreeks De tekstinhoud. Ja

chatCompletionRequestMessageContentPartImage

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type inhoudsonderdeel.
Mogelijke waarden: image_url		 Ja
image_url object Ja

Eigenschappen voor image_url

URL

Name Type Description Standaard
URL tekenreeks Een URL van de afbeelding of de met base64 gecodeerde afbeeldingsgegevens.

gedetailleerd

Name Type Description Standaard
gedetailleerd tekenreeks Hiermee geeft u het detailniveau van de afbeelding op. Meer informatie vindt u in de Vision-handleiding. auto

chatCompletionRequestMessageContentPartRefusal

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type inhoudsonderdeel.
Mogelijke waarden: weigering		 Ja
weigering tekenreeks Het weigeringsbericht dat door het model is gegenereerd. Ja

azureChatExtensionConfiguration

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.

Name Type Beschrijving Vereist Standaardinstelling
type azureChatExtensionType Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een chatgesprek
voltooiingsaanvraag die azure OpenAI-chatextensies moet gebruiken om het antwoordgedrag te verbeteren.
Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.		 Ja

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 chatgesprek
voltooiingsaanvraag die azure OpenAI-chatextensies moet gebruiken om het antwoordgedrag te verbeteren.
Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

Type: tekenreeks

Standaard:

Enum-naam: AzureChatExtensionType

Enum-waarden:

Weergegeven als Beschrijving
azure_search Vertegenwoordigt het gebruik van Azure Search als een Azure OpenAI-chatextensie.
azure_cosmos_db Vertegenwoordigt het gebruik van Azure Cosmos DB als een Azure OpenAI-chatextensie.
elasticsearch Vertegenwoordigt het gebruik van elasticsearch-index® als een Azure OpenAI-chatextensie.
mongo_db Vertegenwoordigt het gebruik van Mongo DB als een Azure OpenAI-chatextensie.
dennenappel Vertegenwoordigt het gebruik van de Pinecone-index als een Azure OpenAI-chatextensie.

azureSearchChatExtensionConfiguration

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

Name Type Beschrijving Vereist Standaardinstelling
type azureChatExtensionType Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een chatgesprek
voltooiingsaanvraag die azure OpenAI-chatextensies moet gebruiken om het antwoordgedrag te verbeteren.
Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.		 Ja
parameters azureSearchChatExtensionParameters Parameters voor Azure Search wanneer deze worden gebruikt als een Azure OpenAI-chatextensie. Nee

azureSearchChatExtensionParameters

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

Name Type Beschrijving Vereist Standaardinstelling
verificatie onYourDataApiKeyAuthenticationOptions of onYourDataSystemAssignedManagedIdentityAuthenticationOptions of onYourDataUserAssignedManagedIdentityAuthenticationOptions of onYourDataAccessTokenAuthenticationOptions Ja
top_n_documents geheel getal Het geconfigureerde bovenste aantal documenten dat moet worden aanbevolen voor de geconfigureerde query. Nee
max_search_queries geheel getal Het maximum aantal herschreven query's dat naar de zoekprovider moet worden verzonden voor één gebruikersbericht. Als dit niet is opgegeven, bepaalt het systeem het aantal query's dat moet worden verzonden. Nee
allow_partial_result boolean Als dit is opgegeven als waar, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt. Nee Onwaar
in_scope boolean Of query's moeten worden beperkt tot het gebruik van geïndexeerde gegevens. Nee
gestrengheid geheel getal De geconfigureerde striktheid van het filteren op zoekrelevantie. Hoe strikter, hoe hoger de precisie, maar een lagere terugroeping van het antwoord. Nee
endpoint tekenreeks Het absolute eindpuntpad voor de Azure Search-resource die moet worden gebruikt. Ja
index_name tekenreeks De naam van de index die moet worden gebruikt als beschikbaar in de Azure Search-resource waarnaar wordt verwezen. Ja
fields_mapping azureSearchIndexFieldMappingOptions Optionele instellingen om te bepalen hoe velden worden verwerkt bij het gebruik van een geconfigureerde Azure Search-resource. Nee
query_type azureSearchQueryType Het type Azure Search-ophaalquery dat moet worden uitgevoerd wanneer u deze gebruikt als een Azure OpenAI-chatextensie. Nee
semantic_configuration tekenreeks De aanvullende semantische configuratie voor de query. Nee
filter tekenreeks Zoekfilter. Nee
embedding_dependency onYourDataEndpointVectorizationSource of onYourDataDeploymentNameVectorizationSource of onYourDataIntegratedVectorizationSource Nee
include_contexts matrix De opgenomen eigenschappen van de uitvoercontext. Als dit niet is opgegeven, is de standaardwaarde en citations intent. Nee

azureSearchIndexFieldMappingOptions

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

Name Type Beschrijving Vereist Standaardinstelling
title_field tekenreeks De naam van het indexveld dat moet worden gebruikt als titel. Nee
url_field tekenreeks De naam van het indexveld dat moet worden gebruikt als URL. Nee
filepath_field tekenreeks De naam van het indexveld dat moet worden gebruikt als bestandspad. Nee
content_fields matrix De namen van indexvelden die als inhoud moeten worden behandeld. Nee
content_fields_separator tekenreeks Het scheidingsteken dat inhoudsvelden moeten gebruiken. Nee
vector_fields matrix De namen van velden die vectorgegevens vertegenwoordigen. Nee
image_vector_fields matrix De namen van velden die afbeeldingsvectorgegevens vertegenwoordigen. Nee

azureSearchQueryType

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:

Weergegeven als Beschrijving
eenvoudig Vertegenwoordigt de standaard, eenvoudige queryparser.
semantisch Vertegenwoordigt de semantische queryparser voor geavanceerde semantische modellering.
vector Vertegenwoordigt vectorzoekopdrachten over berekende gegevens.
vector_simple_hybrid Vertegenwoordigt een combinatie van de eenvoudige querystrategie met vectorgegevens.
vector_semantic_hybrid Vertegenwoordigt een combinatie van semantische zoek- en vectorgegevensquery's.

azureCosmosDBChatExtensionConfiguration

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

Name Type Beschrijving Vereist Standaardinstelling
type azureChatExtensionType Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een chatgesprek
voltooiingsaanvraag die azure OpenAI-chatextensies moet gebruiken om het antwoordgedrag te verbeteren.
Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.		 Ja
parameters azureCosmosDBChatExtensionParameters Parameters die moeten worden gebruikt bij het configureren van Azure OpenAI op uw gegevens-chatextensies bij gebruik van Azure Cosmos DB voor
MongoDB vCore.		 Nee

azureCosmosDBChatExtensionParameters

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

Name Type Beschrijving Vereist Standaardinstelling
verificatie onYourDataConnectionStringAuthenticationOptions De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een verbindingsreeks gebruikt. Ja
top_n_documents geheel getal Het geconfigureerde bovenste aantal documenten dat moet worden aanbevolen voor de geconfigureerde query. Nee
max_search_queries geheel getal Het maximum aantal herschreven query's dat naar de zoekprovider moet worden verzonden voor één gebruikersbericht. Als dit niet is opgegeven, bepaalt het systeem het aantal query's dat moet worden verzonden. Nee
allow_partial_result boolean Als dit is opgegeven als waar, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt. Nee Onwaar
in_scope boolean Of query's moeten worden beperkt tot het gebruik van geïndexeerde gegevens. Nee
gestrengheid geheel getal De geconfigureerde striktheid van het filteren op zoekrelevantie. Hoe strikter, hoe hoger de precisie, maar een lagere terugroeping van het antwoord. Nee
database_name tekenreeks De naam van de MongoDB vCore-database die moet worden gebruikt met Azure Cosmos DB. Ja
container_name tekenreeks De naam van de Azure Cosmos DB-resourcecontainer. Ja
index_name tekenreeks De naam van de MongoDB vCore-index die moet worden gebruikt met Azure Cosmos DB. Ja
fields_mapping azureCosmosDBFieldMappingOptions Optionele instellingen om te bepalen hoe velden worden verwerkt bij het gebruik van een geconfigureerde Azure Cosmos DB-resource. Ja
embedding_dependency onYourDataEndpointVectorizationSource of onYourDataDeploymentNameVectorizationSource Ja
include_contexts matrix De opgenomen eigenschappen van de uitvoercontext. Als dit niet is opgegeven, is de standaardwaarde en citations intent. Nee

azureCosmosDBFieldMappingOptions

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

Name Type Beschrijving Vereist Standaardinstelling
title_field tekenreeks De naam van het indexveld dat moet worden gebruikt als titel. Nee
url_field tekenreeks De naam van het indexveld dat moet worden gebruikt als URL. Nee
filepath_field tekenreeks De naam van het indexveld dat moet worden gebruikt als bestandspad. Nee
content_fields matrix De namen van indexvelden die als inhoud moeten worden behandeld. Ja
content_fields_separator tekenreeks Het scheidingsteken dat inhoudsvelden moeten gebruiken. Nee
vector_fields matrix De namen van velden die vectorgegevens vertegenwoordigen. Ja

elasticsearchChatExtensionConfiguration

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

Name Type Beschrijving Vereist Standaardinstelling
type azureChatExtensionType Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een chatgesprek
voltooiingsaanvraag die azure OpenAI-chatextensies moet gebruiken om het antwoordgedrag te verbeteren.
Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.		 Ja
parameters elasticsearchChatExtensionParameters Parameters die moeten worden gebruikt bij het configureren van Elasticsearch® als een Azure OpenAI-chatextensie. Nee

elasticsearchChatExtensionParameters

Parameters die moeten worden gebruikt bij het configureren van Elasticsearch® als een Azure OpenAI-chatextensie.

Name Type Beschrijving Vereist Standaardinstelling
verificatie onYourDataKeyAndKeyIdAuthenticationOptions of onYourDataEncodedApiKeyAuthenticationOptions Ja
top_n_documents geheel getal Het geconfigureerde bovenste aantal documenten dat moet worden aanbevolen voor de geconfigureerde query. Nee
max_search_queries geheel getal Het maximum aantal herschreven query's moet worden verzonden naar de zoekprovider voor één gebruikersbericht. Als dit niet is opgegeven, bepaalt het systeem het aantal query's dat moet worden verzonden. Nee
allow_partial_result boolean Als dit is opgegeven als waar, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt. Nee Onwaar
in_scope boolean Of query's moeten worden beperkt tot het gebruik van geïndexeerde gegevens. Nee
gestrengheid geheel getal De geconfigureerde striktheid van het filteren op zoekrelevantie. Hoe strikter, hoe hoger de precisie, maar een lagere terugroeping van het antwoord. Nee
endpoint tekenreeks Het eindpunt van Elasticsearch®. Ja
index_name tekenreeks De indexnaam van Elasticsearch®. Ja
fields_mapping elasticsearchIndexFieldMappingOptions Optionele instellingen om te bepalen hoe velden worden verwerkt wanneer u een geconfigureerde Elasticsearch-resource® gebruikt. Nee
query_type elasticsearchQueryType Het type elasticsearch-ophaalquery® dat moet worden uitgevoerd wanneer u deze gebruikt als een Azure OpenAI-chatextensie. Nee
embedding_dependency onYourDataEndpointVectorizationSource of onYourDataDeploymentNameVectorizationSource of onYourDataModelIdVectorizationSource Nee
include_contexts matrix De opgenomen eigenschappen van de uitvoercontext. Als dit niet is opgegeven, is de standaardwaarde en citations intent. Nee

elasticsearchIndexFieldMappingOptions

Optionele instellingen om te bepalen hoe velden worden verwerkt wanneer u een geconfigureerde Elasticsearch-resource® gebruikt.

Name Type Beschrijving Vereist Standaardinstelling
title_field tekenreeks De naam van het indexveld dat moet worden gebruikt als titel. Nee
url_field tekenreeks De naam van het indexveld dat moet worden gebruikt als URL. Nee
filepath_field tekenreeks De naam van het indexveld dat moet worden gebruikt als bestandspad. Nee
content_fields matrix De namen van indexvelden die als inhoud moeten worden behandeld. Nee
content_fields_separator tekenreeks Het scheidingsteken dat inhoudsvelden moeten gebruiken. Nee
vector_fields matrix De namen van velden die vectorgegevens vertegenwoordigen. Nee

elasticsearchQueryType

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

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

Type: tekenreeks

Standaard:

Enum-naam: ElasticsearchQueryType

Enum-waarden:

Weergegeven als Beschrijving
eenvoudig Vertegenwoordigt de standaard, eenvoudige queryparser.
vector Vertegenwoordigt vectorzoekopdrachten over berekende gegevens.

mongoDBChatExtensionConfiguration

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

Name Type Beschrijving Vereist Standaardinstelling
type azureChatExtensionType Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een chatgesprek
voltooiingsaanvraag die azure OpenAI-chatextensies moet gebruiken om het antwoordgedrag te verbeteren.
Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.		 Ja
parameters mongoDBChatExtensionParameters Parameters die moeten worden gebruikt bij het configureren van Azure OpenAI op uw gegevenschatextensies bij gebruik van Mongo DB. Nee

mongoDBChatExtensionParameters

Parameters die moeten worden gebruikt bij het configureren van Azure OpenAI op uw gegevenschatextensies bij gebruik van Mongo DB.

Name Type Beschrijving Vereist Standaardinstelling
verificatie onYourDataUsernameAndPasswordAuthenticationOptions De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een gebruikersnaam en een wachtwoord gebruikt. Ja
top_n_documents geheel getal Het geconfigureerde bovenste aantal documenten dat moet worden aanbevolen voor de geconfigureerde query. Nee
max_search_queries geheel getal Het maximum aantal herschreven query's moet worden verzonden naar de zoekprovider voor één gebruikersbericht. Als dit niet is opgegeven, bepaalt het systeem het aantal query's dat moet worden verzonden. Nee
allow_partial_result boolean Als dit is opgegeven als waar, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt. Nee Onwaar
in_scope boolean Of query's moeten worden beperkt tot het gebruik van geïndexeerde gegevens. Nee
gestrengheid geheel getal De geconfigureerde striktheid van het filteren op zoekrelevantie. Hoe strikter, hoe hoger de precisie, maar een lagere terugroeping van het antwoord. Nee
endpoint tekenreeks De naam van het Mongo DB-clustereindpunt. Ja
database_name tekenreeks De naam van de Mongo DB-database. Ja
collection_name tekenreeks De naam van de Mongo DB-verzameling. Ja
app_name tekenreeks De naam van de Mongo DB-toepassing. Ja
index_name tekenreeks De naam van de Mongo DB-index. Ja
fields_mapping mongoDBFieldMappingOptions Optionele instellingen om te bepalen hoe velden worden verwerkt bij het gebruik van een geconfigureerde Mongo DB-resource. Ja
embedding_dependency onYourDataEndpointVectorizationSource of onYourDataDeploymentNameVectorizationSource Ja
include_contexts matrix De opgenomen eigenschappen van de uitvoercontext. Als dit niet is opgegeven, is de standaardwaarde en citations intent. Nee

mongoDBFieldMappingOptions

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

Name Type Beschrijving Vereist Standaardinstelling
title_field tekenreeks De naam van het indexveld dat moet worden gebruikt als titel. Nee
url_field tekenreeks De naam van het indexveld dat moet worden gebruikt als URL. Nee
filepath_field tekenreeks De naam van het indexveld dat moet worden gebruikt als bestandspad. Nee
content_fields matrix De namen van indexvelden die als inhoud moeten worden behandeld. Ja
content_fields_separator tekenreeks Het scheidingsteken dat inhoudsvelden moeten gebruiken. Nee
vector_fields matrix De namen van velden die vectorgegevens vertegenwoordigen. Ja

pineconeChatExtensionConfiguration

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

Name Type Beschrijving Vereist Standaardinstelling
type azureChatExtensionType Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een chatgesprek
voltooiingsaanvraag die azure OpenAI-chatextensies moet gebruiken om het antwoordgedrag te verbeteren.
Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.		 Ja
parameters pineconeChatExtensionParameters Parameters voor het configureren van Azure OpenAI Pinecone-chatextensies. Nee

pineconeChatExtensionParameters

Parameters voor het configureren van Azure OpenAI Pinecone-chatextensies.

Name Type Beschrijving Vereist Standaardinstelling
verificatie onYourDataApiKeyAuthenticationOptions De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een API-sleutel gebruikt. Ja
top_n_documents geheel getal Het geconfigureerde bovenste aantal documenten dat moet worden aanbevolen voor de geconfigureerde query. Nee
max_search_queries geheel getal Het maximum aantal herschreven query's moet worden verzonden naar de zoekprovider voor één gebruikersbericht. Als dit niet is opgegeven, bepaalt het systeem het aantal query's dat moet worden verzonden. Nee
allow_partial_result boolean Als dit is opgegeven als waar, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt. Nee Onwaar
in_scope boolean Of query's moeten worden beperkt tot het gebruik van geïndexeerde gegevens. Nee
gestrengheid geheel getal De geconfigureerde striktheid van het filteren op zoekrelevantie. Hoe strikter, hoe hoger de precisie, maar een lagere terugroeping van het antwoord. Nee
omgeving tekenreeks De omgevingsnaam van Pinecone. Ja
index_name tekenreeks De naam van de database-index pinecone. Ja
fields_mapping pineconeFieldMappingOptions Optionele instellingen om te bepalen hoe velden worden verwerkt bij het gebruik van een geconfigureerde Pinecone-resource. Ja
embedding_dependency onYourDataDeploymentNameVectorizationSource De details van een vectorisatiebron, die wordt gebruikt door Azure OpenAI Op uw gegevens bij het toepassen van vectorzoekopdrachten, die is gebaseerd op
op de naam van een interne insluitingsmodelimplementatie in dezelfde Azure OpenAI-resource.		 Ja
include_contexts matrix De opgenomen eigenschappen van de uitvoercontext. Als dit niet is opgegeven, is de standaardwaarde en citations intent. Nee

pineconeFieldMappingOptions

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

Name Type Beschrijving Vereist Standaardinstelling
title_field tekenreeks De naam van het indexveld dat moet worden gebruikt als titel. Nee
url_field tekenreeks De naam van het indexveld dat moet worden gebruikt als URL. Nee
filepath_field tekenreeks De naam van het indexveld dat moet worden gebruikt als bestandspad. Nee
content_fields matrix De namen van indexvelden die als inhoud moeten worden behandeld. Ja
content_fields_separator tekenreeks Het scheidingsteken dat inhoudsvelden moeten gebruiken. Nee

onYourDataAuthenticationOptions

De verificatieopties voor Azure OpenAI op uw gegevens.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja

onYourDataContextProperty

De contexteigenschap.

Beschrijving: De contexteigenschap.

Type: tekenreeks

Standaard:

Enum-naam: OnYourDataContextProperty

Enum-waarden:

Weergegeven als Beschrijving
Citaten De citations eigenschap.
intentie De intent eigenschap.
all_retrieved_documents De all_retrieved_documents eigenschap.

onYourDataAuthenticationType

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:

Weergegeven als Beschrijving
api_key Verificatie via API-sleutel.
connection_string Verificatie via verbindingsreeks.
key_and_key_id Verificatie via sleutel- en sleutel-id-paar.
encoded_api_key Verificatie via gecodeerde API-sleutel.
access_token Verificatie via toegangstoken.
system_assigned_managed_identity Verificatie via door het systeem toegewezen beheerde identiteit.
user_assigned_managed_identity Verificatie via door de gebruiker toegewezen beheerde identiteit.
username_and_password Verificatie via gebruikersnaam en wachtwoord.

onYourDataApiKeyAuthenticationOptions

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

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja
sleutel tekenreeks De API-sleutel die moet worden gebruikt voor verificatie. Nee

onYourDataConnectionStringAuthenticationOptions

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

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja
connection_string tekenreeks Het verbindingsreeks dat moet worden gebruikt voor verificatie. Nee

onYourDataKeyAndKeyAndKeyIdAuthenticationOptions

De verificatieopties voor Azure OpenAI Op uw gegevens wanneer u een Elasticsearch-sleutel en sleutel-id-paar gebruikt.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja
sleutel tekenreeks De Elasticsearch-sleutel die moet worden gebruikt voor verificatie. Nee
key_id tekenreeks De elasticsearch-sleutel-id die moet worden gebruikt voor verificatie. Nee

onYourDataEncodedApiKeyAuthenticationOptions

De verificatieopties voor Azure OpenAI Op uw gegevens wanneer u een met Elasticsearch gecodeerde API-sleutel gebruikt.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja
encoded_api_key tekenreeks De met Elasticsearch gecodeerde API-sleutel die moet worden gebruikt voor verificatie. Nee

onYourDataAccessTokenAuthenticationOptions

De verificatieopties voor Azure OpenAI Op uw gegevens bij gebruik van toegangstoken.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja
access_token tekenreeks Het toegangstoken dat moet worden gebruikt voor verificatie. Nee

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja
managed_identity_resource_id tekenreeks De resource-id van de door de gebruiker toegewezen beheerde identiteit die moet worden gebruikt voor verificatie. Nee

onYourDataUsernameAndPasswordAuthenticationOptions

De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een gebruikersnaam en een wachtwoord gebruikt.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataAuthenticationType De verificatietypen die worden ondersteund met Azure OpenAI op uw gegevens. Ja
gebruikersnaam tekenreeks De gebruikersnaam die moet worden gebruikt voor verificatie. Nee
password tekenreeks Het wachtwoord. te gebruiken voor verificatie. Nee

onYourDataVectorizationSource

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

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataVectorizationSourceType Vertegenwoordigt de beschikbare bronnen die Azure OpenAI op uw gegevens kunnen gebruiken om vectorisatie van gegevens te configureren voor gebruik met
vector zoeken.		 Ja

onYourDataVectorizationSourceType

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:

Weergegeven als Beschrijving
endpoint Vertegenwoordigt vectorisatie die wordt uitgevoerd door openbare serviceaanroepen naar een Azure OpenAI-insluitingsmodel.
deployment_name Vertegenwoordigt de implementatienaam van een Ada-model die moet worden gebruikt. Deze modelimplementatie moet zich in dezelfde Azure OpenAI-resource bevinden, maar
Op Uw gegevens wordt deze modelimplementatie gebruikt via een interne aanroep in plaats van een openbare aanroep, waardoor vector mogelijk is
zelfs in privénetwerken zoeken.
geïntegreerd Vertegenwoordigt de geïntegreerde vectorizer die is gedefinieerd in de zoekresource.
model_id Vertegenwoordigt een specifieke insluitingsmodel-id zoals gedefinieerd in de zoekservice.
Momenteel alleen ondersteund door Elasticsearch®.

onYourDataEndpointVectorizationSource

De details van een vectorisatiebron, die wordt gebruikt door Azure OpenAI Op uw gegevens bij het toepassen van vectorzoekopdrachten, die is gebaseerd op een Azure OpenAI-eindpuntaanroep voor insluitingen.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataVectorizationSourceType Vertegenwoordigt de beschikbare bronnen die Azure OpenAI op uw gegevens kunnen gebruiken om vectorisatie van gegevens te configureren voor gebruik met
vector zoeken.		 Ja
endpoint tekenreeks Hiermee geeft u de URL van het broneindpunt op waaruit insluitingen moeten worden opgehaald. Het moet de indeling hebben van https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. De queryparameter api-versie is niet toegestaan. Nee
verificatie onYourDataApiKeyAuthenticationOptions of onYourDataAccessTokenAuthenticationOptions Nee
dimensions geheel getal Het aantal dimensies dat de insluitingen moeten hebben. Alleen ondersteund in text-embedding-3 en latere modellen. Nee

onYourDataDeploymentNameVectorizationSource

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.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataVectorizationSourceType Vertegenwoordigt de beschikbare bronnen die Azure OpenAI op uw gegevens kunnen gebruiken om vectorisatie van gegevens te configureren voor gebruik met
vector zoeken.		 Ja
deployment_name tekenreeks Hiermee geeft u de naam op van de modelimplementatie die moet worden gebruikt voor vectorisatie. Deze modelimplementatie moet zich in dezelfde Azure OpenAI-resource bevinden, maar op uw gegevens wordt deze modelimplementatie gebruikt via een interne aanroep in plaats van een openbare, waardoor vectorzoekopdrachten zelfs in particuliere netwerken mogelijk zijn. Nee
dimensions geheel getal Het aantal dimensies dat de insluitingen moeten hebben. Alleen ondersteund in text-embedding-3 en latere modellen. Nee

onYourDataIntegratedVectorizationSource

Vertegenwoordigt de geïntegreerde vectorizer die is gedefinieerd in de zoekresource.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataVectorizationSourceType Vertegenwoordigt de beschikbare bronnen die Azure OpenAI op uw gegevens kunnen gebruiken om vectorisatie van gegevens te configureren voor gebruik met
vector zoeken.		 Ja

onYourDataModelIdVectorizationSource

De details van een vectorisatiebron, die door Azure OpenAI op uw gegevens worden gebruikt bij het toepassen van vectorzoekopdrachten, die is gebaseerd op een id van het zoekservicemodel. Momenteel alleen ondersteund door Elasticsearch®.

Name Type Beschrijving Vereist Standaardinstelling
type onYourDataVectorizationSourceType Vertegenwoordigt de beschikbare bronnen die Azure OpenAI op uw gegevens kunnen gebruiken om vectorisatie van gegevens te configureren voor gebruik met
vector zoeken.		 Ja
model_id tekenreeks Hiermee geeft u de model-id op die moet worden gebruikt voor vectorisatie. Deze model-id moet worden gedefinieerd in de zoekservice. Nee

azureChatExtensionsMessageContext

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.

Name Type Beschrijving Vereist Standaardinstelling
Citaten matrix Het resultaat van het ophalen van de gegevensbron, dat wordt gebruikt om het assistentbericht in het antwoord te genereren. Nee
intentie tekenreeks De gedetecteerde intentie uit de chatgeschiedenis, die wordt gebruikt om door te geven aan de volgende beurt om de context over te dragen. Nee
all_retrieved_documents matrix Alle opgehaalde documenten. Nee

citaat

Bronvermeldingsinformatie voor een antwoordbericht over het voltooien van een chat.

Name Type Beschrijving Vereist Standaardinstelling
content tekenreeks De inhoud van de bronvermelding. Ja
title tekenreeks De titel van de bronvermelding. Nee
URL tekenreeks De URL van de bronvermelding. Nee
bestandspad tekenreeks Het bestandspad van de bronvermelding. Nee
chunk_id tekenreeks De segment-id van de bronvermelding. Nee
rerank_score Nummer De herrankingsscore van het opgehaalde document. Nee

retrievedDocument

Het opgehaalde document.

Name Type Beschrijving Vereist Standaardinstelling
content tekenreeks De inhoud van de bronvermelding. Ja
title tekenreeks De titel van de bronvermelding. Nee
URL tekenreeks De URL van de bronvermelding. Nee
bestandspad tekenreeks Het bestandspad van de bronvermelding. Nee
chunk_id tekenreeks De segment-id van de bronvermelding. Nee
rerank_score Nummer De herrankingsscore van het opgehaalde document. Nee
search_queries matrix De zoekquery's die worden gebruikt om het document op te halen. Nee
data_source_index geheel getal De index van de gegevensbron. Nee
original_search_score Nummer De oorspronkelijke zoekscore van het opgehaalde document. Nee
filter_reason filterReason De filterreden van het opgehaalde document. Nee

filterReason

De filterreden van het opgehaalde document.

Beschrijving: De filterreden van het opgehaalde document.

Type: tekenreeks

Standaard:

Enum-naam: FilterReason

Enum-waarden:

Weergegeven als Beschrijving
score Het document wordt gefilterd op de oorspronkelijke drempelwaarde voor zoekscore die is gedefinieerd door strictness configureren.
opnieuwrankeren Het document wordt niet gefilterd op oorspronkelijke drempelwaarde voor zoekscores, maar wordt gefilterd op herrankeren en top_n_documents configureren.

chatCompletionMessageToolCall

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van de aanroep van het hulpprogramma. Ja
type toolCallType Het type van de aanroep van het hulpprogramma, in dit geval function. Ja
function object De functie die het model heeft aangeroepen. Ja

Eigenschappen voor functie

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie die moet worden aangeroepen.

Argumenten

Name Type Description Standaard
Argumenten tekenreeks De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en mogelijk parameters genereert die niet zijn gedefinieerd door uw functieschema. Valideer de argumenten in uw code voordat u de functie aanroept.

toolCallType

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:

Weergegeven als Beschrijving
function Het aanroeptype van het hulpprogramma is functie.

chatCompletionRequestMessageTool

Name Type Beschrijving Vereist Standaardinstelling
tool_call_id tekenreeks De aanroep van het hulpprogramma waarop dit bericht reageert. Nee
content tekenreeks De inhoud van het bericht. Nee

chatCompletionRequestMessageFunction

Name Type Beschrijving Vereist Standaardinstelling
role enum De rol van de auteur van berichten, in dit geval function.
Mogelijke waarden: functie		 Nee
naam tekenreeks De inhoud van het bericht. Nee
content tekenreeks De inhoud van het bericht. Nee

createChatCompletionResponse

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

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks Een unieke id voor het voltooien van de chat. Ja
prompt_filter_results promptFilterResults 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. Nee
Keuzes matrix Een lijst met opties voor chatvoltooiing. Kan meer dan één zijn als n deze groter is dan 1. Ja
aangemaakt geheel getal De Unix-tijdstempel (in seconden) van het moment waarop de chat is voltooid. Ja
model tekenreeks Het model dat wordt gebruikt voor het voltooien van de chat. Ja
system_fingerprint tekenreeks Deze vingerafdruk vertegenwoordigt de back-endconfiguratie waarmee het model wordt uitgevoerd.

Kan worden gebruikt in combinatie met de seed aanvraagparameter om te begrijpen wanneer er back-endwijzigingen zijn aangebracht die van invloed kunnen zijn op determinisme.
 Nee
object enum Het objecttype, dat altijd chat.completionis.
Mogelijke waarden: chat.completion		 Ja
gebruikt completionUsage Gebruiksstatistieken voor de voltooiingsaanvraag. Nee

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.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks Een unieke id voor het voltooien van de chat. Elk segment heeft dezelfde id. Ja
Keuzes matrix Een lijst met opties voor chatvoltooiing. Kan meer dan één element bevatten als n deze groter is dan 1.
 Ja
aangemaakt geheel getal De Unix-tijdstempel (in seconden) van het moment waarop de chat is voltooid. Elk segment heeft dezelfde tijdstempel. Ja
model tekenreeks Het model om de voltooiing te genereren. Ja
system_fingerprint tekenreeks Deze vingerafdruk vertegenwoordigt de back-endconfiguratie waarmee het model wordt uitgevoerd.
Kan worden gebruikt in combinatie met de seed aanvraagparameter om te begrijpen wanneer er back-endwijzigingen zijn aangebracht die van invloed kunnen zijn op determinisme.
 Nee
object enum Het objecttype, dat altijd chat.completion.chunkis.
Mogelijke waarden: chat.completion.chunk		 Ja

chatCompletionStreamResponseDelta

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

Name Type Beschrijving Vereist Standaardinstelling
content tekenreeks De inhoud van het segmentbericht. Nee
function_call object Afgeschaft en vervangen door tool_calls. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model. Nee
tool_calls matrix Nee
role enum De rol van de auteur van dit bericht.
Mogelijke waarden: systeem, gebruiker, assistent, hulpprogramma		 Nee
weigering tekenreeks Het weigeringsbericht dat door het model is gegenereerd. Nee

Eigenschappen voor function_call

Argumenten

Name Type Description Standaard
Argumenten tekenreeks De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en mogelijk parameters genereert die niet zijn gedefinieerd door uw functieschema. Valideer de argumenten in uw code voordat u de functie aanroept.

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie die moet worden aangeroepen.

chatCompletionMessageToolCallChunk

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal Ja
id tekenreeks De id van de aanroep van het hulpprogramma. Nee
type enum Het type hulpprogramma. Momenteel wordt alleen function ondersteund.
Mogelijke waarden: functie		 Nee
function object Nee

Eigenschappen voor functie

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie die moet worden aangeroepen.

Argumenten

Name Type Description Standaard
Argumenten tekenreeks De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en mogelijk parameters genereert die niet zijn gedefinieerd door uw functieschema. Valideer de argumenten in uw code voordat u de functie aanroept.

chatCompletionStreamOptions

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

Name Type Beschrijving Vereist Standaardinstelling
include_usage boolean Als dit is ingesteld, wordt er vóór het data: [DONE] bericht een extra segment gestreamd. Het usage veld in dit segment toont de gebruiksstatistieken van tokens voor de hele aanvraag en het choices veld is altijd een lege matrix. Alle andere segmenten bevatten ook een usage veld, maar met een null-waarde.
 Nee

chatCompletionChoiceLogProbs

Logboekinformatie over waarschijnlijkheid voor de keuze.

Name Type Beschrijving Vereist Standaardinstelling
content matrix Een lijst met berichteninhoudstokens met informatie over logboekkans. Ja
weigering matrix Een lijst met weigeringstokens voor berichten met informatie over de logboekkans. Nee

chatCompletionTokenLogprob

Name Type Beschrijving Vereist Standaardinstelling
token tekenreeks Het token. Ja
logprob Nummer De logboekkans van dit token. Ja
bytes matrix Een lijst met gehele getallen die de UTF-8 bytes vertegenwoordigen van het token. Handig in gevallen waarin tekens worden vertegenwoordigd door meerdere tokens en hun byteweergaven moeten worden gecombineerd om de juiste tekstweergave te genereren. Dit kan zijn null als er geen bytes-weergave voor het token is. Ja
top_logprobs matrix Lijst met de meest waarschijnlijke tokens en hun logboekkans, op deze tokenpositie. In zeldzame gevallen kan er minder zijn dan het aantal aangevraagde top_logprobs geretourneerde aanvragen. Ja

chatCompletionResponseMessage

Een chatvoltooiingsbericht gegenereerd door het model.

Name Type Beschrijving Vereist Standaardinstelling
role chatCompletionResponseMessageRole De rol van de auteur van het antwoordbericht. Ja
weigering tekenreeks Het weigeringsbericht dat door het model is gegenereerd. Ja
content tekenreeks De inhoud van het bericht. Ja
tool_calls matrix De hulpprogramma-aanroepen die door het model worden gegenereerd, zoals functie-aanroepen. Nee
function_call chatCompletionFunctionCall Afgeschaft en vervangen door tool_calls. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model. Nee
context azureChatExtensionsMessageContext Een weergave van de aanvullende contextinformatie die beschikbaar is wanneer Azure OpenAI-chatextensies betrokken zijn
bij het genereren van een overeenkomstig chat-voltooiingsantwoord. Deze contextinformatie wordt alleen ingevuld wanneer
met behulp van een Azure OpenAI-aanvraag die is geconfigureerd voor het gebruik van een overeenkomende extensie.		 Nee

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

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:

chatCompletionNamedToolChoice

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

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type hulpprogramma. Momenteel wordt alleen function ondersteund.
Mogelijke waarden: functie		 Ja
function object Ja

Eigenschappen voor functie

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie die moet worden aangeroepen.

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.

chatCompletionMessageToolCalls

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

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

chatCompletionFunctionCall

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

Name Type Beschrijving Vereist Standaardinstelling
naam tekenreeks De naam van de functie die moet worden aangeroepen. Ja
Argumenten tekenreeks De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en mogelijk parameters genereert die niet zijn gedefinieerd door uw functieschema. Valideer de argumenten in uw code voordat u de functie aanroept. Ja

completionUsage

Gebruiksstatistieken voor de voltooiingsaanvraag.

Name Type Beschrijving Vereist Standaardinstelling
prompt_tokens geheel getal Aantal tokens in de prompt. Ja
completion_tokens geheel getal Aantal tokens in de gegenereerde voltooiing. Ja
total_tokens geheel getal Het totale aantal tokens dat wordt gebruikt in de aanvraag (prompt + voltooiing). Ja
prompt_tokens_details object Details van de prompttokens. Nee
completion_tokens_details object Uitsplitsing van tokens die worden gebruikt in een voltooiing. Nee

Eigenschappen voor prompt_tokens_details

cached_tokens

Name Type Description Standaard
cached_tokens geheel getal Het aantal prompttokens in de cache.

Eigenschappen voor completion_tokens_details

reasoning_tokens

Name Type Description Standaard
reasoning_tokens geheel getal Tokens die door het model worden gegenereerd voor redenering.

chatCompletionTool

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type hulpprogramma. Momenteel wordt alleen function ondersteund.
Mogelijke waarden: functie		 Ja
function FunctionObject Ja

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

Name Type Beschrijving Vereist Default
beschrijving tekenreeks Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen. Nee
naam tekenreeks De naam van de functie die moet worden aangeroepen. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64. Ja
parameters 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.		 Nee
streng boolean Of u strikte schema-naleving wilt inschakelen bij het genereren van de functieaanroep. Als dit is ingesteld op true, volgt het model het exacte schema dat in het parameters veld is gedefinieerd. Alleen een subset van het JSON-schema wordt ondersteund wanneer strict dit is true. Nee Onwaar

ResponseFormatText

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type antwoordindeling dat wordt gedefinieerd: text
Mogelijke waarden: tekst		 Ja

ResponseFormatJsonObject

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type antwoordindeling dat wordt gedefinieerd: json_object
Mogelijke waarden: json_object		 Ja

ResponseFormatJsonSchemaSchema

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

Er zijn geen eigenschappen gedefinieerd voor dit onderdeel.

ResponseFormatJsonSchema

Name Type Beschrijving Vereist Standaardinstelling
type enum Het type antwoordindeling dat wordt gedefinieerd: json_schema
Mogelijke waarden: json_schema		 Ja
json_schema object Ja

Eigenschappen voor json_schema

beschrijving

Naam Type Description Default
beschrijving tekenreeks Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om te bepalen hoe moet worden gereageerd in de indeling.

naam

Name Type Description Standaard
naam tekenreeks De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.

schema

Name Type Description Standaard
schema ResponseFormatJsonSchemaSchema Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject.

streng

Name Type Description Standaard
streng boolean Of u strikte schema-naleving wilt inschakelen bij het genereren van de uitvoer. Als dit is ingesteld op true, volgt het model altijd het exacte schema dat in het schema veld is gedefinieerd. Alleen een subset van het JSON-schema wordt ondersteund wanneer strict dit is true. Onwaar

chatCompletionChoiceCommon

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal Nee
finish_reason tekenreeks Nee

createTranslationRequest

Vertaalaanvraag.

Name Type Beschrijving Vereist Standaardinstelling
bestand tekenreeks Het audiobestand dat moet worden vertaald. Ja
vraag tekenreeks Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet in het Engels zijn. Nee
response_format audioResponseFormat Hiermee definieert u de indeling van de uitvoer. Nee
temperatuur Nummer De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt. Nee 0

audioResponse

Vertaling of transcriptiereactie toen response_format json was

Name Type Beschrijving Vereist Standaardinstelling
sms verzenden tekenreeks Vertaalde of getranscribeerde tekst. Ja

audioVerboseResponse

Vertaling of transcriptiereactie toen response_format werd verbose_json

Name Type Beschrijving Vereist Standaardinstelling
sms verzenden tekenreeks Vertaalde of getranscribeerde tekst. Ja
taak tekenreeks Type audiotaak. Nee
taal tekenreeks Taal. Nee
duur Nummer Duur. Nee
Segmenten matrix Nee
woorden matrix Nee

audioResponseFormat

Hiermee definieert u de indeling van de uitvoer.

Beschrijving: Definieert de indeling van de uitvoer.

Type: tekenreeks

Standaard:

Enum-waarden:

  • json
  • sms verzenden
  • srt
  • verbose_json
  • vtt

createTranscriptionRequest

Transcriptieaanvraag.

Name Type Beschrijving Vereist Standaardinstelling
bestand tekenreeks Het audiobestandobject dat moet worden getranscribeerd. Ja
vraag tekenreeks Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet overeenkomen met de audiotaal. Nee
response_format audioResponseFormat Hiermee definieert u de indeling van de uitvoer. Nee
temperatuur Nummer De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt. Nee 0
taal tekenreeks De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1-indeling verbetert de nauwkeurigheid en latentie. Nee
timestamp_granularities[] matrix De tijdstempelgranulariteiten die moeten worden ingevuld voor deze transcriptie. response_format moet worden ingesteld verbose_json op het gebruik van tijdstempelgranulariteiten. Of beide van deze opties worden ondersteund: word, of segment. Opmerking: er is geen extra latentie voor segmenttijdstempels, maar het genereren van woordtijdstempels zorgt voor extra latentie. Nee ['segment']

audioSegment

Transcriptie- of vertaalsegment.

Name Type Beschrijving Vereist Standaardinstelling
id geheel getal Segment-id. Nee
zoeken Nummer Verschuiving van het segment. Nee
starten Nummer Segment beginverschil. Nee
end Nummer Eindverschil segment. Nee
sms verzenden tekenreeks Segmenttekst. Nee
Tokens matrix Tokens van de tekst. Nee
temperatuur Nummer Temperatuur. Nee
avg_logprob Nummer Gemiddelde logboekkans. Nee
compression_ratio Nummer Compressieverhouding. Nee
no_speech_prob Nummer Waarschijnlijkheid van 'geen spraak'. Nee

audioWord

Transcriptie of vertaalwoord.

Name Type Beschrijving Vereist Standaardinstelling
woord tekenreeks Word Nee
starten Nummer Beginverschil in Word. Nee
end Nummer Eindverschil van Word. Nee

createSpeechRequest

Spraakaanvraag.

Name Type Beschrijving Vereist Standaardinstelling
invoer tekenreeks De tekst waarvoor audio moet worden gesynthetiseert. De maximumlengte is 4096 tekens. Ja
voice enum De stem die moet worden gebruikt voor spraaksynthese.
Mogelijke waarden: legering, echo, fable, onyx, nova, shimmer		 Ja
response_format enum De indeling om de audio in te synthetiseren.
Mogelijke waarden: mp3, opus, aac, flac, wav, pcm		 Nee
snelheid Nummer De snelheid van de gesynthetiseerde audio. Selecteer een waarde van waaruit 0.25 u wilt 4.0. 1.0 is de standaardwaarde. Nee 1.0

imageQuality

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:

Weergegeven als Beschrijving
standard Standaardkwaliteit creëert afbeeldingen met standaardkwaliteit.
harde schijf Hd-kwaliteit maakt afbeeldingen met gedetailleerdere details en meer consistentie in de afbeelding.

imagesResponseFormat

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:

Weergegeven als Beschrijving
url De URL die tijdelijke toegang biedt om de gegenereerde afbeeldingen te downloaden.
b64_json De gegenereerde afbeeldingen worden geretourneerd als een met base64 gecodeerde tekenreeks.

imageSize

De grootte van de gegenereerde afbeeldingen.

Beschrijving: De grootte van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: 1024x1024

Naam van opsomming: grootte

Enum-waarden:

Weergegeven als Beschrijving
256x256 De gewenste grootte van de gegenereerde afbeelding is 256x256 pixels. Alleen ondersteund voor dall-e-2.
512x512 De gewenste grootte van de gegenereerde afbeelding is 512x512 pixels. Alleen ondersteund voor dall-e-2.
1792x1024 De gewenste grootte van de gegenereerde afbeelding is 1792x1024 pixels. Alleen ondersteund voor dall-e-3.
1024x1792 De gewenste grootte van de gegenereerde afbeelding is 1024x1792 pixels. Alleen ondersteund voor dall-e-3.
1024x1024 De gewenste grootte van de gegenereerde afbeelding is 1024x1024 pixels.

imageStyle

De stijl van de gegenereerde afbeeldingen.

Beschrijving: De stijl van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: levendig

Naam van opsomming: stijl

Enum-waarden:

Weergegeven als Beschrijving
levendig Levendig creëert beelden die hyperrealistisch en dramatisch zijn.
natuurlijk Natuurlijk creëert afbeeldingen die natuurlijker en minder hyperrealistisch zijn.

imageGenerationsRequest

Name Type Beschrijving Vereist Standaardinstelling
vraag tekenreeks Een tekstbeschrijving van de gewenste afbeelding(en). De maximumlengte is 4000 tekens. Ja
n geheel getal Het aantal afbeeldingen dat moet worden gegenereerd. Nee 1
size imageSize De grootte van de gegenereerde afbeeldingen. Nee 1024x1024
response_format imagesResponseFormat De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Nee URL
Gebruiker tekenreeks Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik. Nee
kwaliteit imageQuality De kwaliteit van de afbeelding die wordt gegenereerd. Nee standard
stijl imageStyle De stijl van de gegenereerde afbeeldingen. Nee levendig

generateImagesResponse

Name Type Beschrijving Vereist Standaardinstelling
aangemaakt geheel getal De UNIX-tijdstempel toen de bewerking werd gemaakt. Ja
gegevens matrix De resultaatgegevens van de bewerking, indien geslaagd Ja

imageResult

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

Name Type Beschrijving Vereist Standaardinstelling
URL tekenreeks De afbeeldings-URL. Nee
b64_json tekenreeks De met base64 gecodeerde installatiekopieën Nee
content_filter_results dalleContentFilterResults Informatie over de resultaten van het filteren van inhoud. Nee
revised_prompt tekenreeks De prompt die is gebruikt voor het genereren van de installatiekopieën, als er een revisie op de prompt is uitgevoerd. Nee
prompt_filter_results dalleFilterResults 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. Nee

lijn

Een inhoudsregelobject dat bestaat uit een aangrenzende reeks inhoudselementen, zoals woorden en selectiemarkeringen.

Name Type Beschrijving Vereist Standaardinstelling
sms verzenden tekenreeks Ja
spans matrix Een matrix van spanen die gedetecteerde objecten en de informatie van het begrenzingsvak vertegenwoordigen. Ja

span

Een spanobject dat een gedetecteerd object en de informatie van het begrenzingsvak vertegenwoordigt.

Name Type Beschrijving Vereist Standaardinstelling
sms verzenden tekenreeks De tekstinhoud van het bereik dat het gedetecteerde object vertegenwoordigt. Ja
offset geheel getal De tekenverschuiving binnen de tekst waar de spanwijdte begint. Deze offset wordt gedefinieerd als de positie van het eerste teken van de span, die vanaf het begin van de tekst wordt geteld als Unicode-codepunten. Ja
length geheel getal De lengte van de reeks tekens, gemeten in Unicode-codepunten. Ja
veelhoek matrix Een matrix met objecten die punten in de veelhoek vertegenwoordigen die het gedetecteerde object omsluiten. Ja

runCompletionUsage

Gebruiksstatistieken met betrekking tot de uitvoering. Deze waarde is null als de uitvoering zich niet in een terminalstatus bevindt (d.w.w.v. in_progressqueued, enzovoort).

Name Type Beschrijving Vereist Standaardinstelling
completion_tokens geheel getal Het aantal voltooiingstokens dat in de loop van de uitvoering wordt gebruikt. Ja
prompt_tokens geheel getal Het aantal prompttokens dat in de loop van de uitvoering wordt gebruikt. Ja
total_tokens geheel getal Totaal aantal gebruikte tokens (prompt + voltooiing). Ja

runStepCompletionUsage

Gebruiksstatistieken met betrekking tot de uitvoeringsstap. Deze waarde is null zolang de status van de uitvoeringsstap is in_progress.

Name Type Beschrijving Vereist Standaardinstelling
completion_tokens geheel getal Het aantal voltooiingstokens dat in de loop van de uitvoeringsstap wordt gebruikt. Ja
prompt_tokens geheel getal Het aantal prompttokens dat wordt gebruikt tijdens de uitvoeringsstap. Ja
total_tokens geheel getal Totaal aantal gebruikte tokens (prompt + voltooiing). Ja

assistantsApiResponseFormatOption

Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.

Dit onderdeel kan een van de volgende zijn:

assistantsApiResponseFormat

Een object met een beschrijving van de verwachte uitvoer van het model. Als json_object alleen function het type tools mag worden doorgegeven aan de uitvoering. Als text het model tekst of een willekeurige waarde kan retourneren die nodig is.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Moet een van text of json_object. Nee sms verzenden

type Enum: AssistantsApiResponseFormat

Weergegeven als Beschrijving
sms verzenden
json_object

assistantObject

Vertegenwoordigt een assistant die het model kan aanroepen en hulpprogramma's kan gebruiken.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd assistantis. Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor het moment waarop de assistent is gemaakt. Ja
naam tekenreeks De naam van de assistent. De maximale lengte is 256 tekens.
 Ja
beschrijving tekenreeks De beschrijving van de assistent. De maximale lengte is 512 tekens.
 Ja
model tekenreeks Id van het model dat moet worden gebruikt. U kunt de API lijstmodellen gebruiken om al uw beschikbare modellen weer te geven.
 Ja
Instructies tekenreeks De systeeminstructies die de assistent gebruikt. De maximale lengte is 256.000 tekens.
 Ja
tools matrix Een lijst met hulpprogramma's die is ingeschakeld voor de assistent. Er kunnen maximaal 128 hulpprogramma's per assistent zijn. Hulpprogramma's kunnen van het type code_interpreterzijn, file_searchof function.
 Ja []
tool_resources object Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Ja
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix De id van het vectorarchief dat aan deze assistent is gekoppeld. Er kan maximaal 1 vectorarchief aan de assistent zijn gekoppeld.

object Enum: AssistantObjectType

Weergegeven als Beschrijving
assistent Het objecttype, dat altijd assistent is

createAssistantRequest

Name Type Beschrijving Vereist Standaardinstelling
model Ja
naam tekenreeks De naam van de assistent. De maximale lengte is 256 tekens.
 Nee
beschrijving tekenreeks De beschrijving van de assistent. De maximale lengte is 512 tekens.
 Nee
Instructies tekenreeks De systeeminstructies die de assistent gebruikt. De maximale lengte is 256.000 tekens.
 Nee
tools matrix Een lijst met hulpprogramma's die is ingeschakeld voor de assistent. Er kunnen maximaal 128 hulpprogramma's per assistent zijn. Hulpprogramma's kunnen van het type code_interpreterzijn, retrievalof function.
 Nee []
tool_resources object Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze assistent is gekoppeld. Er kan maximaal 1 vectorarchief aan de assistent zijn gekoppeld.
vector_stores matrix Een helper voor het maken van een vectorarchief met file_ids en deze koppelen aan deze assistent. Er kan maximaal 1 vectorarchief aan de assistent zijn gekoppeld.

modifyAssistantRequest

Name Type Beschrijving Vereist Standaardinstelling
model Nee
naam tekenreeks De naam van de assistent. De maximale lengte is 256 tekens.
 Nee
beschrijving tekenreeks De beschrijving van de assistent. De maximale lengte is 512 tekens.
 Nee
Instructies tekenreeks De systeeminstructies die de assistent gebruikt. De maximale lengte is 32768 tekens.
 Nee
tools matrix Een lijst met hulpprogramma's die is ingeschakeld voor de assistent. Er kunnen maximaal 128 hulpprogramma's per assistent zijn. Hulpprogramma's kunnen van het type code_interpreterzijn, retrievalof function.
 Nee []
tool_resources object Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Hiermee overschrijft u de lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Overschrijft het vectorarchief dat aan deze assistent is gekoppeld. Er kan maximaal 1 vectorarchief aan de assistent zijn gekoppeld.

deleteAssistantResponse

Name Type Beschrijving Vereist Standaardinstelling
id string Ja
verwijderd boolean Ja
object tekenreeks Ja

object Enum: DeleteAssistantResponseState

Weergegeven als Beschrijving
assistant.deleted

listAssistantsResponse

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
gegevens matrix Ja
first_id tekenreeks Ja
last_id tekenreeks Ja
has_more boolean Ja

assistantToolsCode

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Het type hulpprogramma dat wordt gedefinieerd: code_interpreter Ja

type Enum: assistantToolsCodeType

Weergegeven als Beschrijving
code_interpreter

assistantToolsFileSearch

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Het type hulpprogramma dat wordt gedefinieerd: file_search Ja
file_search object Onderdrukkingen voor het zoekprogramma voor bestanden. Nee

max_num_results

Name Type Description Standaard
max_num_results geheel getal Het maximum aantal resultaten dat het hulpprogramma voor het zoeken van bestanden moet uitvoeren. De standaardwaarde is 20 voor gpt-4* modellen en 5 voor gpt-3.5-turbo. Dit getal moet tussen 1 en 50 liggen.

Houd er rekening mee dat het hulpprogramma voor het zoeken van bestanden minder dan max_num_results resultaten kan uitvoeren.

type Enum: assistantToolsFileSearchType

Weergegeven als Beschrijving
file_search

assistantToolsFileSearchTypeOnly

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Het type hulpprogramma dat wordt gedefinieerd: file_search Ja

type Enum: assistantToolsFileSearchType

Weergegeven als Beschrijving
file_search

assistantToolsFunction

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Het type hulpprogramma dat wordt gedefinieerd: function Ja
function object De functiedefinitie. Ja

Eigenschappen voor functie

beschrijving

Naam Type Description Default
beschrijving tekenreeks Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie die moet worden aangeroepen. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.

parameters

Naam Type Description Standaard
parameters chatCompletionFunctionParameters 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.

type Enum: assistantToolsFunction

Weergegeven als Beschrijving
function

truncationObject

Besturingselementen voor hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. Gebruik deze optie om het eerste contextvenster van de uitvoering te beheren.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks De afkappingsstrategie die moet worden gebruikt voor de thread. De standaardwaarde is auto. Als deze optie is ingesteld last_messages, wordt de thread afgekapt tot de n meest recente berichten in de thread. Wanneer deze optie is ingesteldauto, worden berichten in het midden van de thread verwijderd om de contextlengte van het model aan te passen. max_prompt_tokens Ja
last_messages geheel getal Het aantal meest recente berichten uit de thread bij het samenstellen van de context voor de uitvoering. Nee

type Enum: TruncationType

Weergegeven als Beschrijving
auto
last_messages

assistantsApiToolChoiceOption

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

Dit onderdeel kan een van de volgende zijn:

assistantsNamedToolChoice

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

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Het type hulpprogramma. Als het type is function, moet de naam van de functie worden ingesteld Ja
function object Nee

Eigenschappen voor functie

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie die moet worden aangeroepen.

type Enum: AssistantsNamedToolChoiceType

Weergegeven als Beschrijving
function
code_interpreter
file_search

runObject

Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd thread.runis. Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor het moment waarop de uitvoering is gemaakt. Ja
thread_id tekenreeks De id van de thread waarop is uitgevoerd als onderdeel van deze uitvoering. Ja
assistant_id tekenreeks De id van de assistent die wordt gebruikt voor het uitvoeren van deze uitvoering. Ja
status tekenreeks De status van de uitvoering, die kan zijnqueued: , in_progress, requires_action, cancellingcancelled, , failed, , of expiredcompleted. Ja
required_action object Details over de actie die nodig is om door te gaan met de uitvoering. Dit gebeurt null als er geen actie is vereist. Ja
last_error object De laatste fout die aan deze uitvoering is gekoppeld. Dit gebeurt null als er geen fouten zijn. Ja
expires_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoering verloopt. Ja
started_at geheel getal De Unix-tijdstempel (in seconden) voor toen de uitvoering werd gestart. Ja
cancelled_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is geannuleerd. Ja
failed_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is mislukt. Ja
completed_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is voltooid. Ja
incomplete_details object Details over waarom de uitvoering onvolledig is. Dit is null als de uitvoering niet onvolledig is. Ja
model tekenreeks Het model dat de assistent voor deze uitvoering heeft gebruikt. Ja
Instructies tekenreeks De instructies die de assistent voor deze uitvoering heeft gebruikt. Ja
tools matrix De lijst met hulpprogramma's die de assistent voor deze uitvoering heeft gebruikt. Ja []
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Ja
gebruikt runCompletionUsage Gebruiksstatistieken met betrekking tot de uitvoering. Deze waarde is null als de uitvoering zich niet in een terminalstatus bevindt (d.w.w.v. in_progressqueued, enzovoort). Ja
temperatuur Nummer De steekproeftemperatuur die voor deze uitvoering wordt gebruikt. Als dit niet is ingesteld, wordt de standaardwaarde ingesteld op 1. Nee
top_p Nummer De kernsamplingwaarde die voor deze uitvoering wordt gebruikt. Als dit niet is ingesteld, wordt de standaardwaarde ingesteld op 1. Nee
max_prompt_tokens geheel getal Het maximum aantal prompttokens dat is opgegeven voor gebruik in de loop van de uitvoering.
 Ja
max_completion_tokens geheel getal Het maximum aantal voltooiingstokens dat is opgegeven voor gebruik in de loop van de uitvoering.
 Ja
truncation_strategy truncationObject Besturingselementen voor hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. Gebruik deze optie om het eerste contextvenster van de uitvoering te beheren. Ja
tool_choice assistantsApiToolChoiceOption Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model.
none betekent dat het model geen hulpprogramma's aanroept en in plaats daarvan een bericht genereert.
auto is de standaardwaarde en betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een hulpprogramma.
Het opgeven van een bepaald hulpprogramma zoals {"type": "file_search"} of {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpprogramma aan te roepen.
 Ja
parallel_tool_calls ParallelToolCalls Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma. Nee Waar
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Ja

Eigenschappen voor required_action

type

Name Type Description Standaard
type tekenreeks Voorlopig is dit altijd submit_tool_outputs.

submit_tool_outputs

Name Type Description Standaard
tool_calls matrix Een lijst met de relevante hulpprogramma-aanroepen.

Eigenschappen voor last_error

code

Name Type Description Standaard
code tekenreeks Een van server_error of rate_limit_exceeded.

bericht

Name Type Description Standaard
bericht tekenreeks Een door mensen leesbare beschrijving van de fout.

Eigenschappen voor incomplete_details

reason

Name Type Description Standaard
reason tekenreeks De reden waarom de uitvoering onvolledig is. Hiermee wordt verwijst naar welke specifieke tokenlimiet is bereikt tijdens de uitvoering.

object Enum: runObjectType

Weergegeven als Beschrijving
thread.run Het objecttype run dat altijd thread.run is

status Enum: RunObjectStatus

Weergegeven als Beschrijving
Wachtrij De status in de wachtrij
in_progress De status in_progress
requires_action De status required_action
Annuleren De annuleringsstatus
geannuleerd De geannuleerde status
mislukt De status Mislukt
voltooid De voltooide status
vervallen De verlopen status

createRunRequest

Name Type Beschrijving Vereist Standaardinstelling
assistant_id tekenreeks De id van de assistent die moet worden gebruikt om deze uitvoering uit te voeren. Ja
model tekenreeks De implementatie-id van het model dat moet worden gebruikt om deze uitvoering uit te voeren. Als hier een waarde wordt opgegeven, wordt het model dat aan de assistent is gekoppeld, overschreven. Zo niet, dan wordt het model gebruikt dat is gekoppeld aan de assistent. Nee
Instructies tekenreeks Overschrijf het standaardsysteembericht van de assistent. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
additional_instructions tekenreeks Voegt aanvullende instructies toe aan het einde van de instructies voor de uitvoering. Dit is handig voor het wijzigen van het gedrag per uitvoering zonder andere instructies te overschrijven. Nee
additional_messages matrix Voegt extra berichten toe aan de thread voordat u de uitvoering maakt. Nee
tools matrix Overschrijf de hulpprogramma's die de assistent voor deze uitvoering kan gebruiken. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
stroom boolean Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.
 Nee
max_prompt_tokens geheel getal Het maximum aantal prompttokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven prompttokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven prompttokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
max_completion_tokens geheel getal Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven voltooiingstokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven voltooiingstokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
truncation_strategy truncationObject Besturingselementen voor hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. Gebruik deze optie om het eerste contextvenster van de uitvoering te beheren. Nee
tool_choice assistantsApiToolChoiceOption Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model.
none betekent dat het model geen hulpprogramma's aanroept en in plaats daarvan een bericht genereert.
auto is de standaardwaarde en betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een hulpprogramma.
Het opgeven van een bepaald hulpprogramma zoals {"type": "file_search"} of {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpprogramma aan te roepen.
 Nee
parallel_tool_calls ParallelToolCalls Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma. Nee Waar
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

listRunsResponse

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
gegevens matrix Ja
first_id tekenreeks Ja
last_id tekenreeks Ja
has_more boolean Ja

modifyRunRequest

Name Type Beschrijving Vereist Standaardinstelling
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

submitToolOutputsRunRequest

Name Type Beschrijving Vereist Standaardinstelling
tool_outputs matrix Een lijst met hulpprogramma's waarvoor de uitvoer wordt verzonden. Ja
stroom boolean Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.
 Nee

runToolCallObject

Hulpprogramma-aanroepobjecten

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van de aanroep van het hulpprogramma. Er moet naar deze id worden verwezen wanneer u de uitvoer van het hulpprogramma verzendt met behulp van de uitvoer van het hulpprogramma Verzenden om het eindpunt uit te voeren. Ja
type tekenreeks Het type hulpprogramma roept de uitvoer aan. Voorlopig is dit altijd function. Ja
function object De functiedefinitie. Ja

Eigenschappen voor functie

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie.

Argumenten

Name Type Description Standaard
Argumenten tekenreeks De argumenten die door het model worden verwacht, worden doorgegeven aan de functie.

type Enum: RunToolCallObjectType

Weergegeven als Beschrijving
function

createThreadAndRunRequest

Name Type Beschrijving Vereist Standaardinstelling
assistant_id tekenreeks De id van de assistent die moet worden gebruikt om deze uitvoering uit te voeren. Ja
thread createThreadRequest Nee
model tekenreeks De implementatienaam van het model dat moet worden gebruikt om deze uitvoering uit te voeren. Als hier een waarde wordt opgegeven, wordt het model dat aan de assistent is gekoppeld, overschreven. Zo niet, dan wordt het model gebruikt dat is gekoppeld aan de assistent. Nee
Instructies tekenreeks Overschrijf het standaardsysteembericht van de assistent. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
tools matrix Overschrijf de hulpprogramma's die de assistent voor deze uitvoering kan gebruiken. Dit is handig voor het wijzigen van het gedrag per uitvoering. Nee
tool_resources object Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee
temperatuur Nummer Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt.
 Nee 1
top_p Nummer Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd.

Over het algemeen raden we u aan deze of temperatuur te wijzigen, maar niet beide.
 Nee 1
stroom boolean Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.
 Nee
stream_options chatCompletionStreamOptions Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt stream: true.
 Nee Geen
max_prompt_tokens geheel getal Het maximum aantal prompttokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven prompttokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven prompttokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
max_completion_tokens geheel getal Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven voltooiingstokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven voltooiingstokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
 Nee
truncation_strategy truncationObject Besturingselementen voor hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. Gebruik deze optie om het eerste contextvenster van de uitvoering te beheren. Nee
tool_choice assistantsApiToolChoiceOption Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model.
none betekent dat het model geen hulpprogramma's aanroept en in plaats daarvan een bericht genereert.
auto is de standaardwaarde en betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een hulpprogramma.
Het opgeven van een bepaald hulpprogramma zoals {"type": "file_search"} of {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpprogramma aan te roepen.
 Nee
parallel_tool_calls ParallelToolCalls Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma. Nee Waar
response_format assistantsApiResponseFormatOption Hiermee geeft u de indeling op die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106.

Instelling voor { "type": "json_object" } het inschakelen van de JSON-modus, wat garandeert dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie is overschreden max_tokens of het gesprek de maximale contextlengte heeft overschreden.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix De id van het vectorarchief dat aan deze assistent is gekoppeld. Er kan maximaal 1 vectorarchief aan de assistent zijn gekoppeld.

threadObject

Vertegenwoordigt een thread die berichten bevat.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd threadis. Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor het moment waarop de thread is gemaakt. Ja
tool_resources object Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Ja
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Ja

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze thread is gekoppeld. Er kan maximaal 1 vectoropslag aan de thread zijn gekoppeld.

object Enum: ThreadObjectType

Weergegeven als Beschrijving
thread Het type threadobject dat altijd is thread

createThreadRequest

Name Type Beschrijving Vereist Standaardinstelling
messages matrix Een lijst met berichten waarmee de thread moet worden gestart. Nee
tool_resources object Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze thread is gekoppeld. Er kan maximaal 1 vectoropslag aan de thread zijn gekoppeld.
vector_stores matrix Een helper voor het maken van een vectorarchief met file_ids en deze aan deze thread koppelen. Er kan maximaal 1 vectoropslag aan de thread zijn gekoppeld.

modifyThreadRequest

Name Type Beschrijving Vereist Standaardinstelling
tool_resources object Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.
 Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

Eigenschappen voor tool_resources

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar zijn gemaakt voor het code_interpreter hulpprogramma. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld.
 []

file_search

Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze thread is gekoppeld. Er kan maximaal 1 vectoropslag aan de thread zijn gekoppeld.

deleteThreadResponse

Name Type Beschrijving Vereist Standaardinstelling
id string Ja
verwijderd boolean Ja
object tekenreeks Ja

object Enum: DeleteThreadResponseObjectState

Weergegeven als Beschrijving
thread.deleted De status van het antwoordobject verwijderen van threads. Dit is thread.deleted

listThreadsResponse

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
gegevens matrix Ja
first_id tekenreeks Ja
last_id tekenreeks Ja
has_more boolean Ja

messageObject

Vertegenwoordigt een bericht in een thread.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd thread.messageis. Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor het moment waarop het bericht is gemaakt. Ja
thread_id tekenreeks de thread-id waartoe dit bericht behoort. Ja
status tekenreeks De status van het bericht, dat kan zijn in_progress, incompleteof completed. Ja
incomplete_details object In een onvolledig bericht vindt u meer informatie over waarom het bericht onvolledig is. Ja
completed_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer het bericht is voltooid. Ja
incomplete_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer het bericht als onvolledig is gemarkeerd. Ja
role tekenreeks De entiteit die het bericht heeft geproduceerd. Een van user of assistant. Ja
content matrix De inhoud van het bericht in matrix met tekst en/of afbeeldingen. Ja
assistant_id tekenreeks Indien van toepassing, de id van de assistent die dit bericht heeft geschreven. Ja
run_id tekenreeks Indien van toepassing, de id van de uitvoering die is gekoppeld aan de creatie van dit bericht. Ja
Bijlagen matrix Een lijst met bestanden die zijn toegevoegd aan het bericht en de hulpprogramma's waaraan ze zijn toegevoegd. Ja
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Ja

Eigenschappen voor incomplete_details

reason

Name Type Description Standaard
reason tekenreeks De reden waarom het bericht onvolledig is.

object Enum: MessageObjectType

Weergegeven als Beschrijving
thread.message Het berichtobjecttype dat is thread.message

status Enum: MessageObjectStatus

Weergegeven als Beschrijving
in_progress
onvolledig
voltooid

rol Enum: MessageObjectRole

Weergegeven als Beschrijving
Gebruiker
assistent

messageDeltaObject

Vertegenwoordigt een berichtdelta, bijvoorbeeld gewijzigde velden in een bericht tijdens het streamen.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van het bericht waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd thread.message.deltais. Ja
delta object De delta met de velden die zijn gewijzigd in het bericht. Ja

Eigenschappen voor delta

role

Name Type Description Standaard
role tekenreeks De entiteit die het bericht heeft geproduceerd. Een van user of assistant.

content

Name Type Description Standaard
content matrix De inhoud van het bericht in matrix met tekst en/of afbeeldingen.

object Enum: MessageDeltaObjectType

Weergegeven als Beschrijving
thread.message.delta

createMessageRequest

Name Type Beschrijving Vereist Standaardinstelling
role tekenreeks De rol van de entiteit die het bericht maakt. Toegestane waarden zijn:
- user: Geeft aan dat het bericht wordt verzonden door een werkelijke gebruiker en moet in de meeste gevallen worden gebruikt om door de gebruiker gegenereerde berichten weer te geven.
- assistant: Geeft aan dat het bericht wordt gegenereerd door de assistent. Gebruik deze waarde om berichten van de assistent in te voegen in het gesprek.
 Ja
content tekenreeks De inhoud van het bericht. Ja
Bijlagen matrix Een lijst met bestanden die zijn toegevoegd aan het bericht en de hulpmiddelen waaraan ze moeten worden toegevoegd. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

rol Enum: CreateMessageRequestRole

Weergegeven als Beschrijving
Gebruiker
assistent

modifyMessageRequest

Name Type Beschrijving Vereist Standaardinstelling
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

deleteMessageResponse

Name Type Beschrijving Vereist Standaardinstelling
id string Ja
verwijderd boolean Ja
object tekenreeks Ja

object Enum: DeleteMessageResponseObject

Weergegeven als Beschrijving
thread.message.deleted De status van het berichtantwoordobject verwijderen

listMessagesResponse

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
gegevens matrix Ja
first_id tekenreeks Ja
last_id tekenreeks Ja
has_more boolean Ja

messageContentImageFileObject

Verwijst naar een afbeeldingsbestand in de inhoud van een bericht.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd image_file. Ja
image_file object Ja

Eigenschappen voor image_file

file_id

Name Type Description Standaard
file_id tekenreeks De bestands-id van de afbeelding in de inhoud van het bericht.

type Enum: MessageContentImageFileObjectType

Weergegeven als Beschrijving
image_file Het afbeeldingsbestandstype van de berichtinhoud

messageContentTextObject

De tekstinhoud die deel uitmaakt van een bericht.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd text. Ja
sms verzenden object Ja

Eigenschappen voor tekst

waarde

Name Type Description Standaard
waarde tekenreeks De gegevens waaruit de tekst bestaat.

Aantekeningen

Name Type Description Standaard
Aantekeningen matrix

type Enum: messageContentTextObjectType

Weergegeven als Beschrijving
sms verzenden Het tekstobjecttype van de berichtinhoud

messageContentTextAnnotationsFileCitationObject

Een bronvermelding in het bericht die verwijst naar een specifiek citaat uit een specifiek bestand dat is gekoppeld aan de assistent of het bericht. Gegenereerd wanneer de assistent het hulpprogramma ophalen gebruikt om bestanden te doorzoeken.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd file_citation. Ja
sms verzenden tekenreeks De tekst in de berichtinhoud die moet worden vervangen. Ja
file_citation object Ja
start_index geheel getal Ja
end_index geheel getal Ja

Eigenschappen voor file_citation

file_id

Name Type Description Standaard
file_id tekenreeks De id van het specifieke bestand waaruit de bronvermelding afkomstig is.

type Enum: FileCitationObjectType

Weergegeven als Beschrijving
file_citation Het objecttype bestandsvermelding

messageContentTextAnnotationsFilePathObject

Een URL voor het bestand dat wordt gegenereerd toen de assistent het code_interpreter hulpprogramma gebruikte om een bestand te genereren.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd file_path. Ja
sms verzenden tekenreeks De tekst in de berichtinhoud die moet worden vervangen. Ja
file_path object Ja
start_index geheel getal Ja
end_index geheel getal Ja

Eigenschappen voor file_path

file_id

Name Type Description Standaard
file_id tekenreeks De id van het bestand dat is gegenereerd.

type Enum: FilePathObjectType

Weergegeven als Beschrijving
file_path Het objecttype bestandspad

messageDeltaContentImageFileObject

Verwijst naar een afbeeldingsbestand in de inhoud van een bericht.

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van het inhoudsonderdeel in het bericht. Ja
type tekenreeks Altijd image_file. Ja
image_file object Nee

Eigenschappen voor image_file

file_id

Name Type Description Standaard
file_id tekenreeks De bestands-id van de afbeelding in de inhoud van het bericht.

type Enum: MessageDeltaContentImageFileObjectType

Weergegeven als Beschrijving
image_file

messageDeltaContentTextObject

De tekstinhoud die deel uitmaakt van een bericht.

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van het inhoudsonderdeel in het bericht. Ja
type tekenreeks Altijd text. Ja
sms verzenden object Nee

Eigenschappen voor tekst

waarde

Name Type Description Standaard
waarde tekenreeks De gegevens waaruit de tekst bestaat.

Aantekeningen

Name Type Description Standaard
Aantekeningen matrix

type Enum: MessageDeltaContentTextObjectType

Weergegeven als Beschrijving
sms verzenden

messageDeltaContentTextAnnotationsFileCitationObject

Een bronvermelding in het bericht die verwijst naar een specifiek citaat uit een specifiek bestand dat is gekoppeld aan de assistent of het bericht. Gegenereerd wanneer de assistent het hulpprogramma 'file_search' gebruikt om bestanden te doorzoeken.

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van de aantekening in het tekstinhoudsonderdeel. Ja
type tekenreeks Altijd file_citation. Ja
sms verzenden tekenreeks De tekst in de berichtinhoud die moet worden vervangen. Nee
file_citation object Nee
start_index geheel getal Nee
end_index geheel getal Nee

Eigenschappen voor file_citation

file_id

Name Type Description Standaard
file_id tekenreeks De id van het specifieke bestand waaruit de bronvermelding afkomstig is.

citaat

Name Type Description Standaard
citaat tekenreeks De specifieke aanhalingsteken in het bestand.

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Weergegeven als Beschrijving
file_citation

messageDeltaContentTextAnnotationsFilePathObject

Een URL voor het bestand dat wordt gegenereerd toen de assistent het code_interpreter hulpprogramma gebruikte om een bestand te genereren.

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van de aantekening in het tekstinhoudsonderdeel. Ja
type tekenreeks Altijd file_path. Ja
sms verzenden tekenreeks De tekst in de berichtinhoud die moet worden vervangen. Nee
file_path object Nee
start_index geheel getal Nee
end_index geheel getal Nee

Eigenschappen voor file_path

file_id

Name Type Description Standaard
file_id tekenreeks De id van het bestand dat is gegenereerd.

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Weergegeven als Beschrijving
file_path

runStepObject

Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van de uitvoeringsstap, waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd assistant.run.stepis. Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoeringsstap is gemaakt. Ja
assistant_id tekenreeks De id van de assistent die is gekoppeld aan de uitvoeringsstap. Ja
thread_id tekenreeks De id van de thread die is uitgevoerd. Ja
run_id tekenreeks De id van de uitvoering waarvan deze uitvoeringsstap deel uitmaakt. Ja
type tekenreeks Het type uitvoeringsstap, dat kan zijn message_creation of tool_calls. Ja
status tekenreeks De status van de uitvoering, die kan zijnin_progress: , cancelled, failedof completedexpired. Ja
step_details runStepDetailsMessageCreationObject of runStepDetailsToolCallsObject De details van de uitvoeringsstap. Ja
last_error object De laatste fout die is gekoppeld aan deze uitvoeringsstap. Dit gebeurt null als er geen fouten zijn. Ja
expired_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoeringsstap is verlopen. Een stap wordt beschouwd als verlopen als de bovenliggende uitvoering is verlopen. Ja
cancelled_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoeringsstap is geannuleerd. Ja
failed_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoeringsstap is mislukt. Ja
completed_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de uitvoeringsstap is voltooid. Ja
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Ja

Eigenschappen voor last_error

code

Name Type Description Standaard
code tekenreeks Een van server_error of rate_limit_exceeded.

bericht

Name Type Description Standaard
bericht tekenreeks Een door mensen leesbare beschrijving van de fout.

object Enum: RunStepObjectType

Weergegeven als Beschrijving
assistant.run.step Het objecttype, dat altijd is assistant.run.step

type Enum: RunStepObjectType

Weergegeven als Beschrijving
message_creation De stap message_creation uitvoeren
tool_calls De stap tool_calls uitvoeren

status Enum: RunStepObjectStatus

Weergegeven als Beschrijving
in_progress De uitvoeringsstatus van de in_progress
geannuleerd De geannuleerde uitvoeringsstatus
mislukt De geannuleerde uitvoeringsstatus
voltooid De geannuleerde uitvoeringsstatus
vervallen De geannuleerde uitvoeringsstatus

runStepDeltaObject

Vertegenwoordigt een delta van een uitvoeringsstap, dat wil bijvoorbeeld eventuele gewijzigde velden in een uitvoeringsstap tijdens het streamen.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van de uitvoeringsstap, waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd thread.run.step.deltais. Ja
delta object De delta met de velden die zijn gewijzigd in de uitvoeringsstap. Ja

Eigenschappen voor delta

step_details

Name Type Description Standaard
step_details runStepDeltaStepDetailsMessageCreationObject of runStepDeltaStepDetailsToolCallsObject De details van de uitvoeringsstap.

object Enum: RunStepDeltaObjectType

Weergegeven als Beschrijving
thread.run.step.delta

listRunStepsResponse

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
gegevens matrix Ja
first_id tekenreeks Ja
last_id tekenreeks Ja
has_more boolean Ja

runStepDetailsMessageCreationObject

Details van het maken van het bericht door de uitvoeringsstap.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd message_creation. Ja
message_creation object Ja

Eigenschappen voor message_creation

message_id

Name Type Description Standaard
message_id tekenreeks De id van het bericht dat door deze uitvoerstap is gemaakt.

type Enum: RunStepDetailsMessageCreationObjectType

Weergegeven als Beschrijving
message_creation

runStepDeltaStepDetailsMessageCreationObject

Details van het maken van het bericht door de uitvoeringsstap.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd message_creation. Ja
message_creation object Nee

Eigenschappen voor message_creation

message_id

Name Type Description Standaard
message_id tekenreeks De id van het bericht dat door deze uitvoerstap is gemaakt.

type Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Weergegeven als Beschrijving
message_creation

runStepDetailsToolCallsObject

Details van de aanroep van het hulpprogramma.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd tool_calls. Ja
tool_calls matrix Er is een matrix met hulpprogramma's aangeroepen waarin de uitvoeringsstap is betrokken. Deze kunnen worden gekoppeld aan een van de drie typen hulpprogramma's: code_interpreterof retrieval function.
 Ja

type Enum: RunStepDetailsToolCallsObjectType

Weergegeven als Beschrijving
tool_calls

runStepDeltaStepDetailsToolCallsObject

Details van de aanroep van het hulpprogramma.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd tool_calls. Ja
tool_calls matrix Er is een matrix met hulpprogramma's aangeroepen waarin de uitvoeringsstap is betrokken. Deze kunnen worden gekoppeld aan een van de drie typen hulpprogramma's: code_interpreterof file_search function.
 Nee

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Weergegeven als Beschrijving
tool_calls

runStepDetailsToolCallsCodeObject

Details van het hulpprogramma code-interpreter die de uitvoeringsstap aanroept, is betrokken.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van de aanroep van het hulpprogramma. Ja
type tekenreeks Het type aanroep van het hulpprogramma. Dit wordt altijd code_interpreter voor dit type hulpprogramma-aanroep. Ja
code_interpreter object De definitie van het hulpprogramma Code Interpreter aanroepen. Ja

Eigenschappen voor code_interpreter

input

Name Type Description Standaard
invoer tekenreeks De invoer voor de aanroep van het hulpprogramma Code Interpreter.

uitvoer

Name Type Description Standaard
uitvoer matrix De uitvoer van de aanroep van het hulpprogramma Code Interpreter. Code Interpreter kan een of meer items uitvoeren, waaronder tekst (logs) of afbeeldingen (image). Elk van deze worden vertegenwoordigd door een ander objecttype.

type Enum: RunStepDetailsToolCallsCodeObjectType

Weergegeven als Beschrijving
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Details van het hulpprogramma code-interpreter die de uitvoeringsstap aanroept, is betrokken.

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van de aanroep van het hulpprogramma in het hulpprogramma roept matrix aan. Ja
id tekenreeks De id van de aanroep van het hulpprogramma. Nee
type tekenreeks Het type aanroep van het hulpprogramma. Dit wordt altijd code_interpreter voor dit type hulpprogramma-aanroep. Ja
code_interpreter object De definitie van het hulpprogramma Code Interpreter aanroepen. Nee

Eigenschappen voor code_interpreter

input

Name Type Description Standaard
invoer tekenreeks De invoer voor de aanroep van het hulpprogramma Code Interpreter.

uitvoer

Name Type Description Standaard
uitvoer matrix De uitvoer van de aanroep van het hulpprogramma Code Interpreter. Code Interpreter kan een of meer items uitvoeren, waaronder tekst (logs) of afbeeldingen (image). Elk van deze worden vertegenwoordigd door een ander objecttype.

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Weergegeven als Beschrijving
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

Tekstuitvoer van de aanroep van het hulpprogramma Code Interpreter als onderdeel van een uitvoeringsstap.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd logs. Ja
logboeken tekenreeks De tekstuitvoer van de aanroep van het hulpprogramma Code Interpreter. Ja

type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Weergegeven als Beschrijving
logboeken

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

Tekstuitvoer van de aanroep van het hulpprogramma Code Interpreter als onderdeel van een uitvoeringsstap.

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van de uitvoer in de uitvoermatrix. Ja
type tekenreeks Altijd logs. Ja
logboeken tekenreeks De tekstuitvoer van de aanroep van het hulpprogramma Code Interpreter. Nee

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Weergegeven als Beschrijving
logboeken

runStepDetailsToolCallsCodeOutputImageObject

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd image. Ja
image object Ja

Eigenschappen voor afbeelding

file_id

Name Type Description Standaard
file_id tekenreeks De bestands-id van de afbeelding.

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Weergegeven als Beschrijving
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van de uitvoer in de uitvoermatrix. Ja
type tekenreeks Altijd image. Ja
image object Nee

Eigenschappen voor afbeelding

file_id

Name Type Description Standaard
file_id tekenreeks De bestands-id van de afbeelding.

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Weergegeven als Beschrijving
image

runStepDetailsToolCallsFileSearchObject

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van het aanroepobject van het hulpprogramma. Ja
type tekenreeks Het type aanroep van het hulpprogramma. Dit wordt altijd file_search voor dit type hulpprogramma-aanroep. Ja
file_search object Op dit moment is dit altijd een leeg object. Ja

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Weergegeven als Beschrijving
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van de aanroep van het hulpprogramma in het hulpprogramma roept matrix aan. Ja
id tekenreeks De id van het aanroepobject van het hulpprogramma. Nee
type tekenreeks Het type aanroep van het hulpprogramma. Dit wordt altijd retrieval voor dit type hulpprogramma-aanroep. Ja
file_search object Op dit moment is dit altijd een leeg object. Ja

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Weergegeven als Beschrijving
file_search

runStepDetailsToolCallsFunctionObject

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id van het aanroepobject van het hulpprogramma. Ja
type tekenreeks Het type aanroep van het hulpprogramma. Dit wordt altijd function voor dit type hulpprogramma-aanroep. Ja
function object De definitie van de functie die is aangeroepen. Ja

Eigenschappen voor functie

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie.

Argumenten

Name Type Description Standaard
Argumenten tekenreeks De argumenten die aan de functie zijn doorgegeven.

output

Meetcriterium Type Description Standaard
output tekenreeks De uitvoer van de functie. Dit is null als de uitvoer nog niet is verzonden.

type Enum: RunStepDetailsToolCallsFunctionObjectType

Weergegeven als Beschrijving
function

runStepDeltaStepDetailsToolCallsFunctionObject

Name Type Beschrijving Vereist Standaardinstelling
index geheel getal De index van de aanroep van het hulpprogramma in het hulpprogramma roept matrix aan. Ja
id tekenreeks De id van het aanroepobject van het hulpprogramma. Nee
type tekenreeks Het type aanroep van het hulpprogramma. Dit wordt altijd function voor dit type hulpprogramma-aanroep. Ja
function object De definitie van de functie die is aangeroepen. Nee

Eigenschappen voor functie

naam

Name Type Description Standaard
naam tekenreeks De naam van de functie.

Argumenten

Name Type Description Standaard
Argumenten tekenreeks De argumenten die aan de functie zijn doorgegeven.

output

Meetcriterium Type Description Standaard
output tekenreeks De uitvoer van de functie. Dit is null als de uitvoer nog niet is verzonden.

type Enum: RunStepDetailsToolCallsFunctionObjectType

Weergegeven als Beschrijving
function

vectorStoreExpirationAfter

Het verloopbeleid voor een vectorarchief.

Name Type Beschrijving Vereist Standaardinstelling
anker tekenreeks Ankertijdstempel waarna het verloopbeleid van toepassing is. Ondersteunde ankers: last_active_at. Ja
dagen geheel getal Het aantal dagen na de ankertijd dat het vectorarchief verloopt. Ja

anker Enum: VectorStoreExpirationAfterAnchor

Weergegeven als Beschrijving
last_active_at Het ankertijdstempel waarna het verloopbeleid van toepassing is.

vectorStoreObject

Een vectorarchief is een verzameling verwerkte bestanden die door het file_search hulpprogramma kunnen worden gebruikt.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten. Ja
object enum Het objecttype, dat altijd vector_storeis.
Mogelijke waarden: vector_store		 Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief is gemaakt. Ja
naam tekenreeks De naam van het vectorarchief. Ja
usage_bytes geheel getal Het totale aantal bytes dat door de bestanden in het vectorarchief wordt gebruikt. Ja
file_counts object Ja
status tekenreeks De status van het vectorarchief, dat kan zijn expired, in_progressof completed. Een status van completed geeft aan dat het vectorarchief gereed is voor gebruik. Ja
expires_after vectorStoreExpirationAfter Het verloopbeleid voor een vectorarchief. Nee
expires_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief verloopt. Nee
last_active_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief voor het laatst actief was. Ja
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Ja

Eigenschappen voor file_counts

in_progress

Name Type Description Standaard
in_progress geheel getal Het aantal bestanden dat momenteel wordt verwerkt.

voltooid

Name Type Description Standaard
voltooid geheel getal Het aantal bestanden dat is verwerkt.

mislukt

Name Type Description Standaard
mislukt geheel getal Het aantal bestanden dat niet kan worden verwerkt.

geannuleerd

Name Type Description Standaard
geannuleerd geheel getal Het aantal geannuleerde bestanden.

total

Name Type Description Standaard
total geheel getal Het totale aantal bestanden.

status Enum: VectorStoreObjectStatus

Weergegeven als Beschrijving
vervallen
in_progress
voltooid

createVectorStoreRequest

Name Type Beschrijving Vereist Standaardinstelling
file_ids matrix Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals file_search die toegang hebben tot bestanden. Nee
naam tekenreeks De naam van het vectorarchief. Nee
expires_after vectorStoreExpirationAfter Het verloopbeleid voor een vectorarchief. Nee
chunking_strategy autoChunkingStrategyRequestParam of staticChunkingStrategyRequestParam De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt. Alleen van toepassing als file_ids dit niet nodig is. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

updateVectorStoreRequest

Name Type Beschrijving Vereist Standaardinstelling
naam tekenreeks De naam van het vectorarchief. Nee
expires_after vectorStoreExpirationAfter Het verloopbeleid voor een vectorarchief. Nee
metagegevens object Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
 Nee

listVectorStoresResponse

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
gegevens matrix Ja
first_id tekenreeks Ja
last_id tekenreeks Ja
has_more boolean Ja

deleteVectorStoreResponse

Name Type Beschrijving Vereist Standaardinstelling
id string Ja
verwijderd boolean Ja
object tekenreeks Ja

object Enum: DeleteVectorStoreResponseObject

Weergegeven als Beschrijving
vector_store.deleted De status van het antwoordobject van het vectorarchief verwijderen

vectorStoreFileObject

Een lijst met bestanden die zijn gekoppeld aan een vectorarchief.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd vector_store.fileis. Ja
usage_bytes geheel getal Het totale gebruik van vectoropslag in bytes. Houd er rekening mee dat dit mogelijk verschilt van de oorspronkelijke bestandsgrootte. Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor het moment dat het vectorarchiefbestand is gemaakt. Ja
vector_store_id tekenreeks De id van het vectorarchief waaraan het bestand is gekoppeld. Ja
status tekenreeks De status van het vectorarchiefbestand, dat kan zijnin_progress, completedof cancelledfailed. De status completed geeft aan dat het vectorarchiefbestand gereed is voor gebruik. Ja
last_error object De laatste fout die is gekoppeld aan dit vectorarchiefbestand. Dit gebeurt null als er geen fouten zijn. Ja
chunking_strategy autoChunkingStrategyRequestParam of staticChunkingStrategyRequestParam De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt. Alleen van toepassing als file_ids dit niet nodig is. Nee

Eigenschappen voor last_error

code

Name Type Description Standaard
code tekenreeks Een van server_error of rate_limit_exceeded.

bericht

Name Type Description Standaard
bericht tekenreeks Een door mensen leesbare beschrijving van de fout.

object Enum: VectorStoreFileObjectType

Weergegeven als Beschrijving
vector_store.file

status Enum: VectorStoreFileObjectStatus

Weergegeven als Beschrijving
in_progress
voltooid
geannuleerd
mislukt

otherChunkingStrategyResponseParam

Dit wordt geretourneerd wanneer de segmenteringsstrategie onbekend is. Dit komt meestal doordat het bestand is geïndexeerd voordat het chunking_strategy concept in de API werd geïntroduceerd.

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd other. Ja

type Enum: OtherChunkingStrategyResponseParamType

Weergegeven als Beschrijving
other

staticChunkingStrategyResponseParam

Name Type Beschrijving Vereist Standaardinstelling
type tekenreeks Altijd static. Ja
statisch staticChunkingStrategy Ja

type Enum: StaticChunkingStrategyResponseParamType

Weergegeven als Beschrijving
statisch

staticChunkingStrategy

Name Type Beschrijving Vereist Standaardinstelling
max_chunk_size_tokens geheel getal Het maximum aantal tokens in elk segment. De standaardwaarde is 800. De minimumwaarde is 100 en de maximumwaarde is 4096. Ja
chunk_overlap_tokens geheel getal Het aantal tokens dat overlapt tussen segmenten. De standaardwaarde is 400.

Houd er rekening mee dat de overlapping niet groter mag zijn dan de helft van max_chunk_size_tokens.
 Ja

autoChunkingStrategyRequestParam

De standaardstrategie. Deze strategie maakt momenteel gebruik van een max_chunk_size_tokens van 800 en chunk_overlap_tokens van 400.

Name Type Beschrijving Vereist Standaardinstelling
type enum Altijd auto.
Mogelijke waarden: automatisch		 Ja

staticChunkingStrategyRequestParam

Name Type Beschrijving Vereist Standaardinstelling
type enum Altijd static.
Mogelijke waarden: statisch		 Ja
statisch staticChunkingStrategy Ja

chunkingStrategyRequestParam

De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt.

Dit onderdeel kan een van de volgende zijn:

createVectorStoreFileRequest

Name Type Beschrijving Vereist Standaardinstelling
file_id tekenreeks Een bestands-id die door het vectorarchief moet worden gebruikt. Handig voor hulpprogramma's zoals file_search die toegang hebben tot bestanden. Ja
chunking_strategy chunkingStrategyRequestParam De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt. Nee

listVectorStoreFilesResponse

Name Type Beschrijving Vereist Standaardinstelling
object tekenreeks Ja
gegevens matrix Ja
first_id tekenreeks Ja
last_id tekenreeks Ja
has_more boolean Ja

deleteVectorStoreFileResponse

Name Type Beschrijving Vereist Standaardinstelling
id string Ja
verwijderd boolean Ja
object tekenreeks Ja

object Enum: DeleteVectorStoreFileResponseObject

Weergegeven als Beschrijving
vector_store.file.deleted

vectorStoreFileBatchObject

Een batch bestanden die zijn gekoppeld aan een vectorarchief.

Name Type Beschrijving Vereist Standaardinstelling
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten. Ja
object tekenreeks Het objecttype, dat altijd vector_store.file_batchis. Ja
created_at geheel getal De Unix-tijdstempel (in seconden) voor wanneer de batch vectoropslagbestanden is gemaakt. Ja
vector_store_id tekenreeks De id van het vectorarchief waaraan het bestand is gekoppeld. Ja
status tekenreeks De status van de bestandsbatch van de vectoropslag, die kan zijnin_progress, completedcancelled of failed. Ja
file_counts object Ja

Eigenschappen voor file_counts

in_progress

Name Type Description Standaard
in_progress geheel getal Het aantal bestanden dat momenteel wordt verwerkt.

voltooid

Name Type Description Standaard
voltooid geheel getal Het aantal bestanden dat is verwerkt.

mislukt

Name Type Description Standaard
mislukt geheel getal Het aantal bestanden dat niet kan worden verwerkt.

geannuleerd

Name Type Description Standaard
geannuleerd geheel getal Het aantal bestanden dat is geannuleerd.

total

Name Type Description Standaard
total geheel getal Het totale aantal bestanden.

object Enum: VectorStoreFileBatchObjectType

Weergegeven als Beschrijving
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Weergegeven als Beschrijving
in_progress
voltooid
geannuleerd
mislukt

createVectorStoreFileBatchRequest

Name Type Beschrijving Vereist Standaardinstelling
file_ids matrix Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals file_search die toegang hebben tot bestanden. Ja
chunking_strategy chunkingStrategyRequestParam De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt. Nee

assistantStreamEvent

Vertegenwoordigt een gebeurtenis die wordt verzonden bij het streamen van een uitvoering.

Elke gebeurtenis in een stroom met door de server verzonden gebeurtenissen heeft een event en data eigenschap:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

We verzenden gebeurtenissen wanneer een nieuw object wordt gemaakt, overgangen naar een nieuwe status of worden gestreamd in delen (delta's). We verzenden thread.run.created bijvoorbeeld wanneer een nieuwe uitvoering wordt gemaakt, thread.run.completed wanneer een uitvoering is voltooid, enzovoort. Wanneer een assistent ervoor kiest om een bericht te maken tijdens een uitvoering, verzenden we een thread.message.created event, een thread.message.in_progress gebeurtenis, veel thread.message.delta gebeurtenissen en tot slot een thread.message.completed gebeurtenis.

We kunnen in de loop van de tijd extra gebeurtenissen toevoegen, dus we raden u aan onbekende gebeurtenissen correct in uw code te verwerken.

Dit onderdeel kan een van de volgende zijn:

threadStreamEvent

Dit onderdeel kan een van de volgende zijn:

thread.created

Treedt op wanneer er een nieuwe thread wordt gemaakt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens threadObject Vertegenwoordigt een thread die berichten bevat. Ja

Gegevens: threadObject

Gebeurtenis-enum: ThreadStreamEventEnum

Weergegeven als Beschrijving
thread.created De door de thread gemaakte gebeurtenis

runStreamEvent

Dit onderdeel kan een van de volgende zijn:

thread.run.created

Treedt op wanneer er een nieuwe uitvoering wordt gemaakt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventCreated

Weergegeven als Beschrijving
thread.run.created

thread.run.queued

Treedt op wanneer een uitvoering naar een queued status wordt verplaatst.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventQueued

Weergegeven als Beschrijving
thread.run.queued

thread.run.in_progress

Treedt op wanneer een uitvoering naar een in_progress status wordt verplaatst.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventInProgress

Weergegeven als Beschrijving
thread.run.in_progress

thread.run.requires_action

Treedt op wanneer een uitvoering naar een requires_action status wordt verplaatst.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventRequiresAction

Weergegeven als Beschrijving
thread.run.requires_action

thread.run.completed

Treedt op wanneer een uitvoering is voltooid.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventCompleted

Weergegeven als Beschrijving
thread.run.completed

thread.run.failed

Treedt op wanneer een uitvoering mislukt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventFailed

Weergegeven als Beschrijving
thread.run.failed

thread.run.cancelling

Treedt op wanneer een uitvoering naar een cancelling status wordt verplaatst.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventCancelling

Weergegeven als Beschrijving
thread.run.cancelling

thread.run.cancelled

Treedt op wanneer een uitvoering wordt geannuleerd.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventCancelled

Weergegeven als Beschrijving
thread.run.cancelled

thread.run.expired

Treedt op wanneer een uitvoering verloopt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runObject Vertegenwoordigt een uitvoering die wordt uitgevoerd op een thread. Ja

Gegevens: runObject

Gebeurtenis-enum: RunStreamEventExpired

Weergegeven als Beschrijving
thread.run.expired

runStepStreamEvent

Dit onderdeel kan een van de volgende zijn:

thread.run.step.created

Vindt plaats wanneer een uitvoeringsstap wordt gemaakt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runStepObject Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.
 Ja

Gegevens: runStepObject

Gebeurtenis-enum: RunStepStreamEventCreated

Weergegeven als Beschrijving
thread.run.step.created

thread.run.step.in_progress

Treedt op wanneer een uitvoeringsstap naar een in_progress status wordt verplaatst.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runStepObject Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.
 Ja

Gegevens: runStepObject

Gebeurtenis-enum: RunStepStreamEventInProgress

Weergegeven als Beschrijving
thread.run.step.in_progress

thread.run.step.delta

Treedt op wanneer delen van een uitvoeringsstap worden gestreamd.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runStepDeltaObject Vertegenwoordigt een delta van een uitvoeringsstap, dat wil bijvoorbeeld eventuele gewijzigde velden in een uitvoeringsstap tijdens het streamen.
 Ja

Gegevens: runStepDeltaObject

Gebeurtenis-enum: RunStepStreamEventDelta

Weergegeven als Beschrijving
thread.run.step.delta

thread.run.step.completed

Treedt op wanneer een uitvoeringsstap is voltooid.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runStepObject Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.
 Ja

Gegevens: runStepObject

Gebeurtenis-enum: RunStepStreamEventCompleted

Weergegeven als Beschrijving
thread.run.step.completed

thread.run.step.failed

Treedt op wanneer een uitvoeringsstap mislukt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runStepObject Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.
 Ja

Gegevens: runStepObject

Gebeurtenis-enum: RunStepStreamEventFailed

Weergegeven als Beschrijving
thread.run.step.failed

thread.run.step.cancelled

Treedt op wanneer een uitvoeringsstap wordt geannuleerd.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runStepObject Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.
 Ja

Gegevens: runStepObject

Gebeurtenis-enum: RunStepStreamEventCancelled

Weergegeven als Beschrijving
thread.run.step.cancelled

thread.run.step.expired

Treedt op wanneer een uitvoeringsstap verloopt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens runStepObject Vertegenwoordigt een stap bij het uitvoeren van een uitvoering.
 Ja

Gegevens: runStepObject

Gebeurtenis-enum: RunStepStreamEventExpired

Weergegeven als Beschrijving
thread.run.step.expired

messageStreamEvent

Dit onderdeel kan een van de volgende zijn:

thread.message.created

Treedt op wanneer een bericht wordt gemaakt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens messageObject Vertegenwoordigt een bericht in een thread. Ja

Gegevens: messageObject

Gebeurtenis-enum: MessageStreamEventCreated

Weergegeven als Beschrijving
thread.message.created

thread.message.in_progress

Treedt op wanneer een bericht naar een in_progress status wordt verplaatst.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens messageObject Vertegenwoordigt een bericht in een thread. Ja

Gegevens: messageObject

Gebeurtenis-enum: MessageStreamEventInProgress

Weergegeven als Beschrijving
thread.message.in_progress

thread.message.delta

Treedt op wanneer delen van een bericht worden gestreamd.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens messageDeltaObject Vertegenwoordigt een berichtdelta, bijvoorbeeld gewijzigde velden in een bericht tijdens het streamen.
 Ja

Gegevens: messageDeltaObject

Gebeurtenis-enum: MessageStreamEventDelta

Weergegeven als Beschrijving
thread.message.delta

thread.message.completed

Treedt op wanneer een bericht is voltooid.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens messageObject Vertegenwoordigt een bericht in een thread. Ja

Gegevens: messageObject

Gebeurtenis-enum: MessageStreamEventCompleted

Weergegeven als Beschrijving
thread.message.completed

thread.message.incomplete

Treedt op wanneer een bericht eindigt voordat het is voltooid.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens messageObject Vertegenwoordigt een bericht in een thread. Ja

Gegevens: messageObject

Gebeurtenis-enum: MessageStreamEventIncomplete

Weergegeven als Beschrijving
thread.message.incomplete

errorEvent

Treedt op wanneer er een fout optreedt. Dit kan gebeuren vanwege een interne serverfout of een time-out.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens fout Ja

gebeurtenis Enum: ErrorEventEnum

Weergegeven als Beschrijving
error

doneEvent

Treedt op wanneer een stream eindigt.

Name Type Beschrijving Vereist Standaardinstelling
gebeurtenis tekenreeks Ja
gegevens tekenreeks Ja

gebeurtenis Enum: DoneEventEnum

Weergegeven als Beschrijving
Gereed

data Enum: DoneEventDataEnum

Weergegeven als Beschrijving
[GEREED]

Volgende stappen

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