Förhandsversionsreferens för Azure OpenAI i Azure AI Foundry Models REST API

Den här artikeln innehåller information om rest-API-slutpunkterna för inferens för Azure OpenAI.

API-specifikationer

Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelade på tre primära API-ytor:

• Kontrollplan
• Dataplan – redigering
• Dataplan – slutsatsdragning

Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har en egen unik uppsättning förhandsversioner och stabila/allmänt tillgängliga API-versioner (GA). Förhandsversioner tenderar för närvarande att följa en månatlig takt.

Authentication

Azure OpenAI tillhandahåller två metoder för autentisering. Du kan använda ANTINGEN API-nycklar eller Microsoft Entra-ID.

• API-nyckelautentisering: För den här typen av autentisering måste alla API-begäranden innehålla API-nyckeln i api-key HTTP-huvudet. Snabbstarten innehåller vägledning för hur du gör anrop med den här typen av autentisering.

• Microsoft Entra-ID-autentisering: Du kan autentisera ett API-anrop med hjälp av en Microsoft Entra-token. Autentiseringstoken ingår i en begäran som Authorization rubrik. Den angivna token måste föregås av Bearer, till exempel Bearer YOUR_AUTH_TOKEN. Du kan läsa vår guide om autentisering med Microsoft Entra-ID.

REST API-versionshantering

Tjänst-API:erna versionshanteras med frågeparametern api-version. Alla versioner följer datumstrukturen ÅÅÅÅÅ-MM-DD. Till exempel:

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

Slutsatsdragning av dataplan

Resten av artikeln beskriver 2025-04-01-preview förhandsversionen av inferensspecifikationen för Azure OpenAI-dataplanet.

Om du letar efter dokumentation om den senaste GA API-versionen läser du det senaste API:et för ga-dataplansinferens

Slutföranden – Skapa

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

Skapar ett slutförande för den angivna prompten, parametrarna och den valda modellen.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Examples

Example

Skapar ett slutförande för den angivna prompten, parametrarna och den valda modellen.

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
}

Svar: Statuskod: 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
    }
  }
}

Inbäddningar – Skapa

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

Få en vektorrepresentation av en viss indata som enkelt kan användas av maskininlärningsmodeller och algoritmer.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnera inbäddningarna för en viss fråga.

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

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

Svar: Statuskod: 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
    }
  }
}

Chatten har slutförts – Skapa

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

Skapar ett slutförande för chattmeddelandet

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Examples

Example

Skapar ett slutförande för den angivna prompten, parametrarna och den valda modellen.

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

Svar: Statuskod: 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

Skapar ett slutförande baserat på Azure Search-data och systemtilldelad hanterad identitet.

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

Svar: Statuskod: 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

Skapar ett slutförande baserat på Azure Search-bildvektordata.

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

Svar: Statuskod: 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

Skapar ett slutförande baserat på Azure Search-vektordata, tidigare assistentmeddelande och användartilldelad hanterad identitet.

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

Svar: Statuskod: 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

Skapar ett slutförande för den angivna 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"
     ]
    }
   }
  }
 ]
}

Svar: Statuskod: 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

Skapar ett slutförande för den angivna Mongo DB:en.

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

Svar: Statuskod: 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

Skapar ett slutförande för den angivna 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}"
    }
   }
  }
 ]
}

Svar: Statuskod: 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

Skapar ett slutförande för den angivna Pinecone-resursen.

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

Svar: Statuskod: 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
    }
  }
}

Transkriptioner – Skapa

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

Transkriberar ljud till indataspråket.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 200

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

Example

Hämtar transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 200

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

Översättningar – Skapa

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

Transkriberar och översätter indataljud till engelsk text.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar engelskspråkig transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 200

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

Example

Hämtar engelskspråkig transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 200

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

Tal – Skapa

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

Genererar ljud från indatatexten.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Syntetiserar ljud från den angivna texten.

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

Svar: Statuskod: 200

{
  "body": "101010101"
}

Bildgenerationer – Skapa

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

Genererar en batch med bilder från en textbeskrivning på en specifik DALLE- eller gpt-image-1-modellimplementering.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: Ok

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

Example

Skapar avbildningar med en uppmaning.

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

Svar: Statuskod: 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
          }
        }
      }
    ]
  }
}

Bildgenerationer – Redigera

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

Redigerar en bild från en textbeskrivning på en specifik modellimplementering av gpt-image-1

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: Ok

Statuskod: standard

Beskrivning: Ett fel uppstod.

Lista – Assistenter

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

Returnerar en lista över assistenter.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnerar en lista över assistenter.

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

Svar: Statuskod: 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
  }
}

Skapa – assistent

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

Skapa en assistent med en modell och instruktioner.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapa en assistent med en modell och instruktioner.

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

Svar: Statuskod: 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"
  }
}

Hämta - Assistent

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

Hämtar en assistent.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar en assistent.

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

Svar: Statuskod: 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"
  }
}

Ändra – Assistent

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

Ändrar en assistent.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Ändrar en 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"
}

Svar: Statuskod: 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"
  }
}

Ta bort – assistent

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

Ta bort en assistent.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Tar bort en assistent.

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

Svar: Statuskod: 200

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

Skapa – tråd

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

Skapa en tråd.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapar en tråd.

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

Svar: Statuskod: 200

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

Hämta – tråd

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

Hämtar en tråd.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar en tråd.

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

Svar: Statuskod: 200

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

Ändra – tråd

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

Ändrar en tråd.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Ändrar en tråd.

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

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

Svar: Statuskod: 200

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

Ta bort – tråd

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

Ta bort en tråd.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Tar bort en tråd.

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

Svar: Statuskod: 200

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

Lista – Meddelanden

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

Returnerar en lista med meddelanden för en viss tråd.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Lista meddelanden

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

Svar: Statuskod: 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
  }
}

Skapa – meddelande

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

Skapa ett meddelande.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapa ett meddelande.

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

Svar: Statuskod: 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": {}
  }
}

Hämta – meddelande

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

Hämta ett meddelande.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämta ett meddelande.

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

Svar: Statuskod: 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": {}
  }
}

Ändra – meddelande

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

Ändrar ett meddelande.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Ändra ett meddelande.

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

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

Svar: Statuskod: 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"
    }
  }
}

Skapa – tråda och köra

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

Skapa en tråd och kör den i en begäran.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapa en tråd och kör den i en begäran.

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

Svar: Statuskod: 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"
  }
}

Lista – Körningar

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

Returnerar en lista över körningar som tillhör en tråd.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnerar en lista över körningar som tillhör en tråd.

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

Svar: Statuskod: 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
  }
}

Skapa – Kör

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

Skapa en körning.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapa en körning.

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

{
 "assistant_id": "asst_abc123"
}

Svar: Statuskod: 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"
  }
}

Hämta – Kör

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

Hämtar en körning.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Får en körning.

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

Svar: Statuskod: 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": {}
  }
}

Ändra – Kör

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

Ändrar en körning.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Ändrar en körning.

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

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

Svar: Statuskod: 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"
  }
}

Skicka – verktygsutdata som ska köras

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

När en körning har status: "requires_action" och required_action.type är submit_tool_outputskan den här slutpunkten användas för att skicka utdata från verktygsanropen när alla har slutförts. Alla utdata måste skickas i en enda begäran.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

När en körning har status: "requires_action" och required_action.type är submit_tool_outputskan den här slutpunkten användas för att skicka utdata från verktygsanropen när alla har slutförts. Alla utdata måste skickas i en enda begäran.

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

Svar: Statuskod: 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"
  }
}

Avbryt – Kör

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

Avbryter en körning som är in_progress.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Avbryter en körning som är in_progress.

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

Svar: Statuskod: 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"
  }
}

Lista – Körningssteg

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

Returnerar en lista över körningssteg som hör till en körning.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnerar en lista över körningssteg som hör till en körning.

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

Svar: Statuskod: 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
  }
}

Get – Kör steg

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

Hämtar ett körningssteg.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar ett körningssteg.

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

Svar: Statuskod: 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
    }
  }
}

Lista – Vektorlager

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

Returnerar en lista över vektorlager.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnerar en lista över vektorlager.

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

Svar: Statuskod: 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
  }
}

Skapa – vektorarkiv

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

Skapa ett vektorlager.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapar ett vektorlager.

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

Svar: Statuskod: 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
    }
  }
}

Hämta – Vektorarkiv

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

Hämtar ett vektorlager.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar ett vektorlager.

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

Svar: Statuskod: 200

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

Ändra – Vektorarkiv

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

Ändrar ett vektorlager.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Ändrar ett vektorlager.

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

{
 "name": "Support FAQ"
}

Svar: Statuskod: 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
    }
  }
}

Ta bort – vektorarkiv

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

Ta bort ett vektorlager.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Tar bort ett vektorlager.

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

Svar: Statuskod: 200

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

Lista – Vektorlagringsfiler

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

Returnerar en lista över vektorlagringsfiler.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnerar en lista över vektorlagringsfiler.

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

Svar: Statuskod: 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
  }
}

Skapa – Vektorlagringsfil

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

Skapa en vektorlagringsfil genom att koppla en fil till ett vektorlager.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapa en vektorlagringsfil genom att koppla en fil till ett vektorlager.

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

{
 "file_id": "file-abc123"
}

Svar: Statuskod: 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
  }
}

Hämta – Vektorlagringsfil

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

Hämtar en vektorlagringsfil.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar en vektorlagringsfil.

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

Svar: Statuskod: 200

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

Ta bort – Vektorlagringsfil

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

Ta bort en vektorlagringsfil. Då tas filen bort från vektorarkivet, men själva filen tas inte bort. Om du vill ta bort filen använder du borttagningsfilens slutpunkt.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Ta bort en vektorlagringsfil. Då tas filen bort från vektorarkivet, men själva filen tas inte bort. Om du vill ta bort filen använder du borttagningsfilens slutpunkt.

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

Svar: Statuskod: 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

Uppdatera attribut på en vektorlagringsfil.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Hämta filinnehåll för vektorarkiv

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

Hämta det tolkade innehållet i en vektorlagringsfil.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Sök vektorlager

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

Sök i ett vektorlager efter relevanta segment baserat på ett filter för fråge- och filattribut.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Skapa – Vektorlagringsfil batch

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

Skapa en vektorlagringsfilbatch.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Skapa en vektorlagringsfilbatch.

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

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

Svar: Statuskod: 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
  }
}

Get – Vektorlagringsfil batch

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

Hämtar en vektorlagringsfilbatch.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Hämtar en vektorlagringsfilbatch.

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

Svar: Statuskod: 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
    }
  }
}

Avbryt – Vektorlagringsfil batch

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

Avbryt en vektorlagringsfilbatch. Detta försöker avbryta bearbetningen av filer i den här batchen så snart som möjligt.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Avbryt en vektorlagringsfilbatch. Detta försöker avbryta bearbetningen av filer i den här batchen så snart som möjligt.

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

Svar: Statuskod: 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
    }
  }
}

Lista – Batch-filer för vektorarkiv

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

Returnerar en lista över vektorlagringsfiler i en batch.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Examples

Example

Returnerar en lista över vektorlagringsfiler.

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

Svar: Statuskod: 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
  }
}

Skapa – realtidssession

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

Skapa en tillfällig API-token för användning i program på klientsidan med API:et Realtime. Kan konfigureras med samma sessionsparametrar som klienthändelsen session.update . Den svarar med ett sessionsobjekt, plus en client_secret nyckel som innehåller en användbar tillfälliga API-token som kan användas för att autentisera webbläsarklienter för Realtids-API:et.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: Sessionen har skapats.

Skapa – Transkription-realtidssession

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

Skapa en tillfällig API-token för användning i program på klientsidan med Realtids-API:et specifikt för transkriptioner i realtid. Kan konfigureras med samma sessionsparametrar som klienthändelsen transcription_session.update . Den svarar med ett sessionsobjekt, plus en client_secret nyckel som innehåller en användbar tillfälliga API-token som kan användas för att autentisera webbläsarklienter för Realtids-API:et.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: Sessionen har skapats.

Responses

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

Skapar ett modellsvar.

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Api för svar – indataobjekt

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

Hämtar ett modellsvar med angivet ID.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Ta bort svar

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

Tar bort ett modellsvar med angivet ID.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Statuskod: 404

Beskrivning: Hittades inte

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Svars-API – lista över svarsobjekt

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

Returnerar en lista över indataobjekt för ett givet svar.

URI parametrar

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Responses

Statuskod: 200

Beskrivning: OK

Components

errorResponse

errorBase

error