Class DataSourceFieldMappings
The DataSourceFieldMappings.
Inheritance
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.AI.OpenAI.dll
Syntax
[OpenAI.CodeGenType("AzureSearchChatDataSourceParametersFieldsMapping")]
public class DataSourceFieldMappings : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.DataSourceFieldMappings>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.DataSourceFieldMappings>Constructors
DataSourceFieldMappings()
Initializes a new instance of DataSourceFieldMappings.
Declaration
public DataSourceFieldMappings ();Properties
ContentFieldNames
The names of index fields that should be treated as content.
Declaration
[OpenAI.CodeGenMember("ContentFields")]
public System.Collections.Generic.IList<string> ContentFieldNames { get; }Property Value
|
System.Collections.Generic.IList<System.String>
|
Remarks
This field is applicable to data source types including: AzureSearchChatDataSource, CosmosChatDataSource, ElasticsearchChatDataSource, and PineconeChatDataSource.
ContentFieldSeparator
The separator pattern that content fields should use.
Declaration
[OpenAI.CodeGenMember("ContentFieldsSeparator")]
public string ContentFieldSeparator { get; set; }Property Value
|
System.String
|
Remarks
This field is applicable to data source types including: AzureSearchChatDataSource, CosmosChatDataSource, ElasticsearchChatDataSource, and PineconeChatDataSource.
FilePathFieldName
The name of the index field to use as a filepath.
Declaration
[OpenAI.CodeGenMember("FilepathField")]
public string FilePathFieldName { get; set; }Property Value
|
System.String
|
Remarks
This field is applicable to data source types including: AzureSearchChatDataSource, CosmosChatDataSource, ElasticsearchChatDataSource, and PineconeChatDataSource.
ImageVectorFieldNames
The names of fields that represent image vector data.
Declaration
[OpenAI.CodeGenMember("ImageVectorFields")]
public System.Collections.Generic.IList<string> ImageVectorFieldNames { get; }Property Value
|
System.Collections.Generic.IList<System.String>
|
Remarks
This configuration is only applicable to AzureSearchChatDataSource.
TitleFieldName
The name of the index field to use as a title.
Declaration
[OpenAI.CodeGenMember("TitleField")]
public string TitleFieldName { get; set; }Property Value
|
System.String
|
UrlFieldName
The name of the index field to use as a URL.
Declaration
[OpenAI.CodeGenMember("UrlField")]
public string UrlFieldName { get; set; }Property Value
|
System.String
|
Remarks
This field is applicable to data source types including: AzureSearchChatDataSource, CosmosChatDataSource, ElasticsearchChatDataSource, and PineconeChatDataSource.
VectorFieldNames
The names of fields that represent vector data.
Declaration
[OpenAI.CodeGenMember("VectorFields")]
public System.Collections.Generic.IList<string> VectorFieldNames { get; }Property Value
|
System.Collections.Generic.IList<System.String>
|
Remarks
This field is applicable to data source types including: AzureSearchChatDataSource, CosmosChatDataSource, and ElasticsearchChatDataSource.
It is not applicable to types including: PineconeChatDataSource.
Methods
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
Declaration
protected virtual Azure.AI.OpenAI.Chat.DataSourceFieldMappings JsonModelCreateCore (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.Text.Json.Utf8JsonReader
reader
The JSON reader. |
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The client options for reading and writing models. |
Returns
|
DataSourceFieldMappings
|
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
Declaration
protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.Text.Json.Utf8JsonWriter
writer
The JSON writer. |
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The client options for reading and writing models. |
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
Declaration
protected virtual Azure.AI.OpenAI.Chat.DataSourceFieldMappings PersistableModelCreateCore (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.BinaryData
data
The data to parse. |
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The client options for reading and writing models. |
Returns
|
DataSourceFieldMappings
|
PersistableModelWriteCore(ModelReaderWriterOptions)
Declaration
protected virtual BinaryData PersistableModelWriteCore (System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The client options for reading and writing models. |
Returns
|
System.BinaryData
|
Operators
Explicit(ClientResult to DataSourceFieldMappings)
Declaration
public static explicit operator Azure.AI.OpenAI.Chat.DataSourceFieldMappings (System.ClientModel.ClientResult result);Parameters
|
System.ClientModel.ClientResult
result
The System.ClientModel.ClientResult to deserialize the DataSourceFieldMappings from. |
Returns
|
DataSourceFieldMappings
|
Implicit(DataSourceFieldMappings to BinaryContent)
Declaration
public static implicit operator System.ClientModel.BinaryContent (Azure.AI.OpenAI.Chat.DataSourceFieldMappings dataSourceFieldMappings);Parameters
|
DataSourceFieldMappings
dataSourceFieldMappings
The DataSourceFieldMappings to serialize into System.ClientModel.BinaryContent. |
Returns
|
System.ClientModel.BinaryContent
|
Explicit Interface Implementations
IJsonModel<DataSourceFieldMappings>.Create(Utf8JsonReader, ModelReaderWriterOptions)
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
Declaration
Azure.AI.OpenAI.Chat.DataSourceFieldMappings IJsonModel<DataSourceFieldMappings>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.Text.Json.Utf8JsonReader
reader
The System.Text.Json.Utf8JsonReader to read. |
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The System.ClientModel.Primitives.ModelReaderWriterOptions to use. |
Returns
|
DataSourceFieldMappings
A |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IJsonModel<DataSourceFieldMappings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
Writes the model to the provided System.Text.Json.Utf8JsonWriter.
Declaration
void IJsonModel<DataSourceFieldMappings>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.Text.Json.Utf8JsonWriter
writer
The System.Text.Json.Utf8JsonWriter to write into. |
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The System.ClientModel.Primitives.ModelReaderWriterOptions to use. |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IPersistableModel<DataSourceFieldMappings>.Create(BinaryData, ModelReaderWriterOptions)
Converts the provided System.BinaryData into a model.
Declaration
Azure.AI.OpenAI.Chat.DataSourceFieldMappings IPersistableModel<DataSourceFieldMappings>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.BinaryData
data
The System.BinaryData to parse. |
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The System.ClientModel.Primitives.ModelReaderWriterOptions to use. |
Returns
|
DataSourceFieldMappings
A |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IPersistableModel<DataSourceFieldMappings>.GetFormatFromOptions(ModelReaderWriterOptions)
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
Declaration
string IPersistableModel<DataSourceFieldMappings>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model. |
Returns
|
System.String
The format that the model uses when communicating with the serivce. |
IPersistableModel<DataSourceFieldMappings>.Write(ModelReaderWriterOptions)
Writes the model into a System.BinaryData.
Declaration
BinaryData IPersistableModel<DataSourceFieldMappings>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
|
System.ClientModel.Primitives.ModelReaderWriterOptions
options
The System.ClientModel.Primitives.ModelReaderWriterOptions to use. |
Returns
|
System.BinaryData
A binary representation of the written model. |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |