Share via


AzureBlobKnowledgeSourceParameters Class

Definition

Parameters for Azure Blob Storage knowledge source.

public class AzureBlobKnowledgeSourceParameters : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.AzureBlobKnowledgeSourceParameters>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.AzureBlobKnowledgeSourceParameters>
type AzureBlobKnowledgeSourceParameters = class
    interface IJsonModel<AzureBlobKnowledgeSourceParameters>
    interface IPersistableModel<AzureBlobKnowledgeSourceParameters>
Public Class AzureBlobKnowledgeSourceParameters
Implements IJsonModel(Of AzureBlobKnowledgeSourceParameters), IPersistableModel(Of AzureBlobKnowledgeSourceParameters)
Inheritance
AzureBlobKnowledgeSourceParameters
Implements

Constructors

AzureBlobKnowledgeSourceParameters(String, String)

Initializes a new instance of AzureBlobKnowledgeSourceParameters.

Properties

ChatCompletionModel

Optional chat completion model for image verbalization or context extraction. Please note KnowledgeAgentModel is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeAgentAzureOpenAIModel.

ConnectionString

Key-based connection string or the ResourceId format if using a managed identity.

ContainerName

The name of the blob storage container.

CreatedResources

Resources created by the knowledge source.

DisableImageVerbalization

Indicates whether image verbalization should be disabled.

EmbeddingModel

Optional vectorizer configuration for vectorizing content. Please note VectorSearchVectorizer is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AIServicesVisionVectorizer, AzureMachineLearningVectorizer, AzureOpenAIVectorizer and WebApiVectorizer.

FolderPath

Optional folder path within the container.

Identity

An explicit identity to use for this knowledge source. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity.

IngestionSchedule

Optional schedule for data ingestion.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<AzureBlobKnowledgeSourceParameters>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AzureBlobKnowledgeSourceParameters>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AzureBlobKnowledgeSourceParameters>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureBlobKnowledgeSourceParameters>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AzureBlobKnowledgeSourceParameters>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to