Naslaginformatie over Azure OpenAI in de REST API-preview voor modellen van Microsoft Foundry

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

API-specificaties

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

• beheerlaag
• Gegevensvlak - ontwerpen
• Gegevensvlak - deductie

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

Authentication

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 2025-04-01-preview preview-versie van de inferencespecificatie van het Azure OpenAI-datavlak.

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=2025-04-01-preview

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

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-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=2025-04-01-preview

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

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Retourneer de insluitingen voor een bepaalde prompt.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Chatvoltooiingen - Maken

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

Hiermee maakt u een voltooiing voor het chatbericht

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Examples

Example

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=2025-04-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
    }
  }
}

Example

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=2025-04-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
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
    }
  }
}

Example

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=2025-04-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
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
    }
  }
}

Example

Hiermee maakt u een voltooiing voor de opgegeven Elasticsearch.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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=2025-04-01-preview

Hiermee wordt audio getranscribeerd in de invoertaal.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: multipart/form-data

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

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=2025-04-01-preview

Antwoorden: Statuscode: 200

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

Example

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=2025-04-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=2025-04-01-preview

Hiermee wordt invoeraudio getranscribeerd en omgezet in Engelse tekst.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: multipart/form-data

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

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=2025-04-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"
  }
}

Example

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=2025-04-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=2025-04-01-preview

Hiermee wordt audio gegenereerd op basis van de invoertekst.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: multipart/form-data

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Synthetiseert audio van de opgegeven tekst.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-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=2025-04-01-preview

Genereert een batch afbeeldingen vanuit een tekstonderschrift op een specifieke implementatie van een DALL-E- of gpt-image-1-seriemodel.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-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
          }
        }
      }
    ]
  }
}

Afbeeldingen genereren - Bewerken

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Een afbeelding bewerken vanuit een tekstbijschrift in een bepaalde gpt-image-1-modelimplementatie

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: multipart/form-data

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Lijst - Assistenten

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

Retourneert een lijst met assistenten.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Retourneert een lijst met assistenten.

GET https://{endpoint}/openai/assistants?api-version=2025-04-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=2025-04-01-preview

Maak een assistent met een model en instructies.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Maak een assistent met een model en instructies.

POST https://{endpoint}/openai/assistants?api-version=2025-04-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=2025-04-01-preview

Hiermee haalt u een assistent op.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee haalt u een assistent op.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-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=2025-04-01-preview

Hiermee wijzigt u een assistent.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wijzigt u een assistent.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-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=2025-04-01-preview

Een assistent verwijderen.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee verwijdert u een assistent.

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

Antwoorden: Statuscode: 200

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

Maken - Thread

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

Een thread maken.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee maakt u een thread.

POST https://{endpoint}/openai/threads?api-version=2025-04-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=2025-04-01-preview

Hiermee wordt een thread opgehaald.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wordt een thread opgehaald.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-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=2025-04-01-preview

Hiermee wijzigt u een thread.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wijzigt u een thread.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-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=2025-04-01-preview

Een thread verwijderen.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wordt een thread verwijderd.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-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=2025-04-01-preview

Retourneert een lijst met berichten voor een bepaalde thread.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Lijst Berichten

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-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=2025-04-01-preview

Maak een bericht.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Maak een bericht.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-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=2025-04-01-preview

Een bericht ophalen.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Een bericht ophalen.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-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=2025-04-01-preview

Hiermee wijzigt u een bericht.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Een bericht wijzigen.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-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=2025-04-01-preview

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

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

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

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-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=2025-04-01-preview

Retourneert een lijst met uitvoeringen die behoren tot een thread.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Retourneert een lijst met uitvoeringen die behoren tot een thread.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-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=2025-04-01-preview

Maak een uitvoering.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Maak een uitvoering.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-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=2025-04-01-preview

Hiermee wordt een uitvoering opgehaald.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Krijgt een vlucht.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-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=2025-04-01-preview

Hiermee wijzigt u een uitvoering.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wijzigt u een uitvoering.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-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=2025-04-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

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

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=2025-04-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=2025-04-01-preview

Annuleert een uitvoering die is in_progress.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Annuleert een uitvoering die is in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-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=2025-04-01-preview

Retourneert een lijst met uitvoeringsstappen die behoren tot een uitvoering.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Retourneert een lijst met uitvoeringsstappen die behoren tot een uitvoering.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-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=2025-04-01-preview

Haalt een uitvoeringsstap op.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Haalt een uitvoeringsstap op.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-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=2025-04-01-preview

Retourneert een lijst met vectorarchieven.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Retourneert een lijst met vectorarchieven.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-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=2025-04-01-preview

Maak een vectorarchief.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee maakt u een vectorarchief.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-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=2025-04-01-preview

Hiermee haalt u een vectorarchief op.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee haalt u een vectorarchief op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-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=2025-04-01-preview

Hiermee wijzigt u een vectorarchief.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wijzigt u een vectorarchief.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-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=2025-04-01-preview

Een vectorarchief verwijderen.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee verwijdert u een vectorarchief.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-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=2025-04-01-preview

Hiermee wordt een lijst met vectoropslagbestanden geretourneerd.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wordt een lijst met vectoropslagbestanden geretourneerd.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-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=2025-04-01-preview

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

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-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=2025-04-01-preview

Hiermee haalt u een vectorarchiefbestand op.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee haalt u een vectorarchiefbestand op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-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=2025-04-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

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

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=2025-04-01-preview

Antwoorden: Statuscode: 200

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

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Kenmerken in een vectorarchiefbestand bijwerken.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Bestandsinhoud van vectoropslag ophalen

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Haal de geparseerde inhoud van een vectorarchiefbestand op.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Zoek vectoropslag

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Zoek in een vectorarchief naar relevante segmenten op basis van een filter voor query- en bestandskenmerken.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Maken - Vector Store File Batch

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

Maak een bestandsbatch voor vectoropslag.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Maak een bestandsbatch voor vectoropslag.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-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=2025-04-01-preview

Hiermee haalt u een bestandsbatch van het vectorarchief op.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee haalt u een bestandsbatch van het vectorarchief op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-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=2025-04-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

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

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=2025-04-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=2025-04-01-preview

Retourneert een lijst met vectoropslagbestanden in een batch.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Examples

Example

Hiermee wordt een lijst met vectoropslagbestanden geretourneerd.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-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 - realtime sessie

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Maak een kortstondig API-token voor gebruik in toepassingen aan de clientzijde met de Realtime-API. Kan worden geconfigureerd met dezelfde sessieparameters als de session.update clientgebeurtenis. Het reageert met een sessieobject, plus een client_secret sleutel die een bruikbaar kortstondig API-token bevat dat kan worden gebruikt voor het verifiëren van browserclients voor de Realtime-API.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: Sessie is gemaakt.

Maken - Transcriptiesessie in real time

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Maak een kortstondig API-token voor gebruik in toepassingen aan de clientzijde met de Realtime-API, specifiek voor realtimetranscripties. Kan worden geconfigureerd met dezelfde sessieparameters als de transcription_session.update clientgebeurtenis. Het reageert met een sessieobject, plus een client_secret sleutel die een bruikbaar kortstondig API-token bevat dat kan worden gebruikt voor het verifiëren van browserclients voor de Realtime-API.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: Sessie is gemaakt.

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Hiermee maakt u een modelantwoord.

Aanvraaglichaam

Inhoudstype: toepassing/json

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Antwoorden-API - invoeritems

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Haalt een modelantwoord op met de opgegeven id.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Antwoord verwijderen

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Verwijdert een modelantwoord met de opgegeven ID.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Statuscode: 404

Beschrijving: Niet gevonden

Statuscode: standaard

Beschrijving: Service niet beschikbaar

Antwoord-API - lijst met antwoordenitems

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Retourneert een lijst met invoeritems voor een bepaald antwoord.

URI-parameters

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Authenticatie met token-gebaseerde verificatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: OK

Components

errorResponse

errorBase