Indexes - Get Version

Service:

AI Foundry

API Version:

v1

Get the specific version of the Index

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	Project endpoint. In the form "https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/_project" if your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the form "https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/<your-project-name>" if you want to explicitly specify the Foundry Project name.
name	path	True	string	The name of the resource
version	path	True	string	The specific version id of the Index to retrieve.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Index: AzureAISearchIndex CosmosDBIndex ManagedAzureAISearchIndex	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://ai.azure.com/.default

Examples

Indexes_GetVersion_MaximumSet

Indexes_GetVersion_MinimumSet

Indexes_GetVersion_MaximumSet

Sample request

HTTP

GET {endpoint}/indexes/ascwgkgwpqxeinbp/versions/bqhzitucneeoxurvf?api-version=v1

Sample response

Status code:

200

{
  "type": "Index",
  "id": "xtjevbrwrwuwkbujuwpq",
  "name": "wwikvkcdcobt",
  "version": "swnonkxmjl"
}

Indexes_GetVersion_MinimumSet

Sample request

HTTP

GET {endpoint}/indexes/sflsamumttlwccuxveocgozlkmdme/versions/txg?api-version=v1

Sample response

Status code:

200

{
  "type": "Index",
  "name": "wwikvkcdcobt",
  "version": "swnonkxmjl"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
AzureAISearchIndex	Azure AI Search Index Definition
CosmosDBIndex	CosmosDB Vector Store Index Definition
EmbeddingConfiguration	Embedding configuration class
FieldMapping	Field mapping configuration class
IndexType
ManagedAzureAISearchIndex	Managed Azure AI Search Index Definition

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

AzureAISearchIndex

Object

Azure AI Search Index Definition

Name	Type	Description
connectionName	string	Name of connection to Azure AI Search
description	string	The asset description text.
fieldMapping	FieldMapping	Field mapping configuration
id	string	Asset ID, a unique identifier for the asset
indexName	string	Name of index in Azure AI Search resource to attach
name	string	The name of the resource
tags	object	Tag dictionary. Tags can be added, removed, and updated.
type	string: AzureSearch	Type of index
version	string	The version of the resource

CosmosDBIndex

Object

CosmosDB Vector Store Index Definition

Name	Type	Description
connectionName	string	Name of connection to CosmosDB
containerName	string	Name of CosmosDB Container
databaseName	string	Name of the CosmosDB Database
description	string	The asset description text.
embeddingConfiguration	EmbeddingConfiguration	Embedding model configuration
fieldMapping	FieldMapping	Field mapping configuration
id	string	Asset ID, a unique identifier for the asset
name	string	The name of the resource
tags	object	Tag dictionary. Tags can be added, removed, and updated.
type	string: CosmosDBNoSqlVectorStore	Type of index
version	string	The version of the resource

EmbeddingConfiguration

Object

Embedding configuration class

Name	Type	Description
embeddingField	string	Embedding field
modelDeploymentName	string	Deployment name of embedding model. It can point to a model deployment either in the parent AIServices or a connection.

FieldMapping

Object

Field mapping configuration class

Name	Type	Description
contentFields	string[]	List of fields with text content
filepathField	string	Path of file to be used as a source of text content
metadataFields	string[]	List of fields with metadata content
titleField	string	Field containing the title of the document
urlField	string	Field containing the url of the document
vectorFields	string[]	List of fields with vector content

IndexType

Enumeration

Value	Description
AzureSearch	Azure search
CosmosDBNoSqlVectorStore	CosmosDB
ManagedAzureSearch	Managed Azure Search

ManagedAzureAISearchIndex

Object

Managed Azure AI Search Index Definition

Name	Type	Description
description	string	The asset description text.
id	string	Asset ID, a unique identifier for the asset
name	string	The name of the resource
tags	object	Tag dictionary. Tags can be added, removed, and updated.
type	string: ManagedAzureSearch	Type of index
vectorStoreId	string	Vector store id of managed index
version	string	The version of the resource