The query type to use with Azure Search. Default is simple
role_information
string
False
Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses.
semantic_configuration
string
False
The semantic configuration for the query. Required when query_type is semantic or vector_semantic_hybrid.
strictness
integer
False
The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. Default is 3.
top_n_documents
integer
False
The configured top number of documents to feature for the configured query. Default is 5.
max_search_queries
integer
False
The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.
allow_partial_result
integer
False
If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails.
include_contexts
array
False
The included properties of the output context. If not specified, the default value is citations and intent. Values can be citations,intent, all_retrieved_documents.
API key authentication options
The authentication options for Azure OpenAI On Your Data when using an API key.
Name
Type
Required
Description
key
string
True
The API key to use for authentication.
type
string
True
Must be api_key.
System assigned managed identity authentication options
The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.
Name
Type
Required
Description
type
string
True
Must be system_assigned_managed_identity.
User assigned managed identity authentication options
The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.
Name
Type
Required
Description
managed_identity_resource_id
string
True
The resource ID of the user-assigned managed identity to use for authentication.
type
string
True
Must be user_assigned_managed_identity.
Access token authentication options
The authentication options for Azure OpenAI On Your Data when using access token.
Name
Type
Required
Description
access_token
string
True
The access token to use for authentication.
type
string
True
Must be access_token.
Deployment name vectorization source
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
Name
Type
Required
Description
deployment_name
string
True
The embedding model deployment name within the same Azure OpenAI resource.
type
string
True
Must be deployment_name.
dimensions
integer
False
The number of dimensions the embeddings should have. Only supported in text-embedding-3 and later models.
Endpoint vectorization source
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on the Azure OpenAI embedding API endpoint.
Name
Type
Required
Description
endpoint
string
True
Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter isn't allowed.
Specifies the authentication options to use when retrieving embeddings from the specified endpoint.
type
string
True
Must be endpoint.
dimensions
integer
False
The number of dimensions the embeddings should have. Only supported in text-embedding-3 and later models.
Fields mapping options
Optional settings to control how fields are processed when using a configured Azure Search resource.
Name
Type
Required
Description
content_fields
string[]
False
The names of index fields that should be treated as content.
vector_fields
string[]
False
The names of fields that represent vector data.
content_fields_separator
string
False
The separator pattern that content fields should use. Default is \n.
filepath_field
string
False
The name of the index field to use as a filepath.
title_field
string
False
The name of the index field to use as a title.
url_field
string
False
The name of the index field to use as a URL.
Query type
The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI On Your Data.
Enum Value
Description
simple
Represents the default, simple query parser.
semantic
Represents the semantic query parser for advanced semantic modeling.
vector
Represents vector search over computed data.
vector_simple_hybrid
Represents a combination of the simple query strategy with vector data.
vector_semantic_hybrid
Represents a combination of semantic search and vector data querying.
Examples
Prerequisites:
Configure the role assignments from Azure OpenAI system assigned managed identity to Azure search service. Required roles: Search Index Data Reader, Search Service Contributor.
Configure the role assignments from the user to the Azure OpenAI resource. Required role: Cognitive Services OpenAI User.