Function GenieDialog_embeddingQuery

Function Documentation

Genie_Status_t GenieDialog_embeddingQuery(const GenieDialog_Handle_t dialogHandle, const void *embeddings, const uint32_t embeddingsSize, const GenieDialog_SentenceCode_t sentenceCode, const GenieDialog_TokenToEmbeddingCallback_t t2eCallback, const GenieDialog_QueryCallback_t callback, const void *userData)

A function to execute a query with embeddings and output text.

Parameters

  • dialogHandle – [in] A dialog handle.

  • embeddings – [in] The input embeddings buffer.

  • embeddingsSize – [in] The total size of the embeddings buffer in bytes.

  • sentenceCode – [in] The sentence code indicating the contents of the query embeddings.

  • t2eCallback – [in] Callback function to handle token-to-embedding conversions.

  • callback – [in] Callback function to handle query responses. Cannot be NULL.

  • userData – [in] User defined field provided in the query responses. Can be NULL.

Returns

Status code:

  • GENIE_STATUS_SUCCESS: API call was successful.

  • GENIE_STATUS_ERROR_INVALID_HANDLE: Dialog handle is invalid.

  • GENIE_STATUS_ERROR_INVALID_ARGUMENT: At least one argument is invalid.

  • GENIE_STATUS_ERROR_QUERY_FAILED: Dialog query failure.

  • GENIE_STATUS_WARNING_CONTEXT_EXCEEDED: Context Limit was exceeded.