@azure-rest/ai-inference package
Interfaces
| ChatChoiceOutput |
Representación de una única finalización de solicitud como parte de una solicitud general de finalización de chat.
Por lo general, las opciones de |
| ChatCompletionsNamedToolChoice |
Una selección de herramientas de una herramienta específica denominada herramienta de función que limitará las finalizaciones de chat al uso de la función con nombre. |
| ChatCompletionsNamedToolChoiceFunction |
Una selección de herramientas de una herramienta específica denominada herramienta de función que limitará las finalizaciones de chat al uso de la función con nombre. |
| ChatCompletionsOutput |
Representación de los datos de respuesta de una solicitud de finalización de chat. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de datos de aviso proporcionados o "completos". |
| ChatCompletionsResponseFormatJsonObject |
Formato de respuesta para finalizaciones de chat que restringe las respuestas a la emisión de objetos JSON válidos. Tenga en cuenta que para habilitar el modo JSON, algunos modelos de IA también pueden requerir que indique al modelo que genere JSON a través de un mensaje de usuario o sistema. |
| ChatCompletionsResponseFormatJsonSchema |
Formato de respuesta para finalizaciones de chat que restringe las respuestas a la emisión de objetos JSON válidos, con un esquema JSON especificado por el autor de la llamada. |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
Define el formato de respuesta para las finalizaciones de chat como JSON con un esquema determinado. El modelo de IA deberá cumplir este esquema al generar finalizaciones. |
| ChatCompletionsResponseFormatParent |
Representa el formato que debe generar el modelo. Úselo para habilitar el modo JSON en lugar del modo de texto predeterminado. Tenga en cuenta que para habilitar el modo JSON, algunos modelos de IA también pueden requerir que indique al modelo que genere JSON a través de un mensaje de usuario o sistema. |
| ChatCompletionsResponseFormatText |
Formato de respuesta para finalizaciones de chat que emite respuestas de texto. Este es el formato de respuesta predeterminado. |
| ChatCompletionsToolCall |
Una llamada a la herramienta de función solicitada por el modelo de IA. |
| ChatCompletionsToolCallOutput |
Una llamada a la herramienta de función solicitada por el modelo de IA. |
| ChatCompletionsToolDefinition |
Definición de una herramienta de finalizaciones de chat que puede llamar a una función. |
| ChatMessageContentItemParent |
Representación abstracta de un elemento de contenido estructurado dentro de un mensaje de chat. |
| ChatMessageImageContentItem |
Elemento de contenido de chat estructurado que contiene una referencia de imagen. |
| ChatMessageImageUrl |
Una ubicación de Internet desde la que el modelo puede recuperar una imagen. |
| ChatMessageTextContentItem |
Elemento de contenido de chat estructurado que contiene texto sin formato. |
| ChatRequestAssistantMessage |
Mensaje de chat de solicitud que representa la respuesta o la acción del asistente. |
| ChatRequestMessageParent |
Representación abstracta de un mensaje de chat tal como se proporciona en una solicitud. |
| ChatRequestSystemMessage |
Mensaje de chat de solicitud que contiene instrucciones del sistema que influyen en cómo el modelo generará una respuesta de finalizaciones de chat. |
| ChatRequestToolMessage |
Mensaje de chat de solicitud que representa la salida solicitada de una herramienta configurada. |
| ChatRequestUserMessage |
Mensaje de chat de solicitud que representa la entrada del usuario al asistente. |
| ChatResponseMessageOutput |
Representación de un mensaje de chat tal como se recibió en una respuesta. |
| CompletionsUsageOutput |
Representación de los recuentos de tokens procesados para una solicitud de finalización. Los recuentos consideran todos los tokens en mensajes, opciones, alternativas de elección, generaciones de best_of y otros consumidores. |
| EmbeddingItemOutput |
Representación de una sola comparación de la relación de incrustaciones. |
| EmbeddingsResultOutput |
Representación de los datos de respuesta de una solicitud de inserción. Las incrustaciones miden la relación de las cadenas de texto y se usan habitualmente para buscar, agrupar en clústeres, recomendaciones y otros escenarios similares. |
| EmbeddingsUsageOutput |
Medición de la cantidad de tokens usados en esta solicitud y respuesta. |
| FunctionCall |
Nombre y argumentos de una función a la que se debe llamar, según lo generado por el modelo. |
| FunctionCallOutput |
Nombre y argumentos de una función a la que se debe llamar, según lo generado por el modelo. |
| FunctionDefinition |
La definición de una función especificada por el autor de la llamada que las finalizaciones de chat pueden invocar en respuesta a la coincidencia de entrada del usuario. |
| GetChatCompletions | |
| GetChatCompletions200Response |
La solicitud se ha realizado correctamente. |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
La solicitud se ha realizado correctamente. |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
La solicitud se ha realizado correctamente. |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
La solicitud se ha realizado correctamente. |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
Representa una imagen con texto opcional. |
| ModelClientOptions |
Parámetros opcionales para el cliente |
| ModelInfoOutput |
Representa información básica sobre el modelo de IA. |
| Routes | |
Alias de tipos
| ChatCompletionsResponseFormat |
Representa el formato que debe generar el modelo. Úselo para habilitar el modo JSON en lugar del modo de texto predeterminado. Tenga en cuenta que para habilitar el modo JSON, algunos modelos de IA también pueden requerir que indique al modelo que genere JSON a través de un mensaje de usuario o sistema. |
| ChatCompletionsToolChoicePreset |
Alias para ChatCompletionsToolChoicePreset |
| ChatMessageContentItem |
Representación abstracta de un elemento de contenido estructurado dentro de un mensaje de chat. |
| ChatMessageImageDetailLevel |
Alias para ChatMessageImageDetailLevel |
| ChatRequestMessage |
Representación abstracta de un mensaje de chat tal como se proporciona en una solicitud. |
| ChatRole |
Alias para ChatRole |
| ChatRoleOutput |
Alias para ChatRoleOutput |
| CompletionsFinishReasonOutput |
Alias para CompletionsFinishReasonOutput |
| EmbeddingEncodingFormat |
Alias para EmbeddingEncodingFormat |
| EmbeddingInputType |
Alias para EmbeddingInputType |
| ExtraParameters |
Alias para ExtraParameters |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
Alias para ModelTypeOutput |
Funciones
Detalles de la función
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Inicialización de una nueva instancia de ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClientParámetros
- endpointParam
-
string
El parámetro endpointParam
- credentials
identificar de forma única las credenciales de cliente
- options
- ModelClientOptions
el parámetro para todos los parámetros opcionales
Devoluciones
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): responseParámetros
Devoluciones
response
Azure SDK for JavaScript