Skip to content

Updating v1 specs with Chat, Embeddings, Responses, and Vector Stores moved out of preview. #36955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 28, 2025
Merged

Updating v1 specs with Chat, Embeddings, Responses, and Vector Stores moved out of preview. #36955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aa4b616
Updating v1 specs with Responses and Chat moved out of preview.
glecaros Aug 26, 2025
69688cf
Adding vector stores
glecaros Aug 26, 2025
9f31581
embeddings
glecaros Aug 26, 2025
9996b16
adding obfuscation
glecaros Aug 26, 2025
b0a9a91
adding doc to obfuscation field
glecaros Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 117 additions & 8 deletions specification/ai/data-plane/OpenAI.v1/azure-v1-preview-generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3063,6 +3063,17 @@
"type": "string"
}
},
{
"name": "include_obfuscation",
"in": "query",
"required": false,
"description": "When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.",
"schema": {
"type": "boolean",
"default": true
},
"explode": false
},
{
"name": "include[]",
"in": "query",
Expand Down Expand Up @@ -6066,6 +6077,28 @@
},
"description": "A content filter result for an image generation operation's output response content."
},
"AzureContentFilterPersonallyIdentifiableInformationResult": {
"type": "object",
"properties": {
"redacted_text": {
"type": "string",
"description": "The redacted text with PII information removed or masked."
},
"sub_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AzurePiiSubCategoryResult"
},
"description": "Detailed results for individual PIIHarmSubCategory(s)."
}
},
"allOf": [
{
"$ref": "#/components/schemas/AzureContentFilterDetectionResult"
}
],
"description": "A content filter detection result for Personally Identifiable Information that includes harm extensions."
},
"AzureContentFilterResultForChoice": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -6187,6 +6220,14 @@
},
"ungrounded_material": {
"$ref": "#/components/schemas/AzureContentFilterCompletionTextSpanDetectionResult"
},
"personally_identifiable_information": {
"allOf": [
{
"$ref": "#/components/schemas/AzureContentFilterPersonallyIdentifiableInformationResult"
}
],
"description": "A detection result that describes matches against Personal Identifiable Information with configurable subcategories."
}
},
"description": "A content filter result for a single response item produced by a generative AI system."
Expand Down Expand Up @@ -7811,6 +7852,34 @@
}
}
},
"AzurePiiSubCategoryResult": {
"type": "object",
"required": [
"sub_category",
"filtered",
"detected",
"redacted"
],
"properties": {
"sub_category": {
"type": "string",
"description": "The PIIHarmSubCategory that was evaluated."
},
"filtered": {
"type": "boolean",
"description": "Whether the content detection resulted in a content filtering action for this subcategory."
},
"detected": {
"type": "boolean",
"description": "Whether the labeled content subcategory was detected in the content."
},
"redacted": {
"type": "boolean",
"description": "Whether the content was redacted for this subcategory."
}
},
"description": "Result details for individual PIIHarmSubCategory(s)."
},
"AzureResponse": {
"type": "object",
"required": [
Expand Down Expand Up @@ -16883,7 +16952,8 @@
"type",
"output_index",
"item_id",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -16905,6 +16975,10 @@
"delta": {
"type": "string",
"description": "The partial code snippet being streamed by the code interpreter."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down Expand Up @@ -17531,7 +17605,8 @@
"type",
"item_id",
"output_index",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -17553,6 +17628,10 @@
"delta": {
"type": "string",
"description": "The function-call arguments delta that is added."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down Expand Up @@ -17842,7 +17921,8 @@
"type",
"output_index",
"item_id",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -17863,6 +17943,10 @@
},
"delta": {
"description": "The partial update to the arguments for the MCP tool call."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down Expand Up @@ -18163,7 +18247,8 @@
"item_id",
"output_index",
"content_index",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -18189,6 +18274,10 @@
},
"delta": {
"description": "The partial update to the reasoning content."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down Expand Up @@ -18248,7 +18337,8 @@
"item_id",
"output_index",
"summary_index",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -18274,6 +18364,10 @@
},
"delta": {
"description": "The partial update to the reasoning summary content."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down Expand Up @@ -18427,7 +18521,8 @@
"item_id",
"output_index",
"summary_index",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -18454,6 +18549,10 @@
"delta": {
"type": "string",
"description": "The text delta that was added to the summary."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down Expand Up @@ -18513,7 +18612,8 @@
"item_id",
"output_index",
"content_index",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -18540,6 +18640,10 @@
"delta": {
"type": "string",
"description": "The refusal text that is added."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down Expand Up @@ -18734,7 +18838,8 @@
"item_id",
"output_index",
"content_index",
"delta"
"delta",
"obfuscation"
],
"properties": {
"type": {
Expand All @@ -18761,6 +18866,10 @@
"delta": {
"type": "string",
"description": "The text delta that was added."
},
"obfuscation": {
"type": "string",
"description": "A field of random characters introduced by stream obfuscation. Stream obfuscation is a mechanism that mitigates certain side-channel attacks."
}
},
"allOf": [
Expand Down
Loading
Loading